POST api/manifestacoes

Cadastra uma manifestação.

Request Information

URI Parameters

None.

Body Parameters

Dados da manifestação a ser incluída.

DadosInclusaoManifestacaoDTO
NameDescriptionTypeAdditional information
NumProtocolo

Número público de identificação da manifestação. Se não informado, um protocolo será gerado e informado. Se informado, utilizar apenas números. Utilizado apenas por ouvidorias: para federais formato COMPROT.

string

None.

IdTipoFormulario

* Obrigatório. Identificação do tipo de formulário. Serviço que lista tipos de formulário disponível na documentação da API.

integer

None.

IdTipoManifestacao

* Obrigatório. Identificação do tipo de manifestação. Serviço que lista tipos de manifestações disponível na documentação da API.

integer

None.

IdOuvidoriaDestino

Identificação da ouvidoria destinatária da manifestação. Serviço que lista ouvidorias disponível na documentação da API.

integer

None.

IdOrgaoDestinatario

Código SIORG de um órgão federal. Pode ser informado no lugar do idOuvidoriaDestinataria. Uma ouvidoria correspondente será mapeada como destinatária. Serviço que lista códigos SIORG utilizados no e-OUV disponível na documentação da API.

integer

None.

CodServicoMPOG

Código de um serviço federal do catálogo do MPOG. Pode ser informado no lugar do destinatário (IdOuvidoriaDestino ou IdOrgaoDestinatario) para formulário do tipo Simplifique. Se informado junto com um destinatário, este deve ser o relacionado ao serviço. Serviço que lista serviços disponível na documentação da API do MPOG: (https://www.servicos.gov.br/api/v1/docs/).

integer

None.

TxtOutroServico

Texto que representa um serviço não listado pelo catálago do MPOG. É informado no lugar do CodServicoMPOG e se utilizado deve informar também o destinatário (IdOuvidoriaDestino ou IDOrgaoDestinatario).

string

None.

IdAssunto

Código do assunto da manifestação. Lista de assuntos disponível na documentação da API.

integer

None.

TextoManifestacao

* Obrigatório. Fale aqui.

string

None.

PropostaMelhoria

Texto com proposta. Obrigatório para formulário do tipo Simplifique.

string

None.

Anexos

Lista de anexos relacionados ao teor da manifestação (atos ou fatos).

Collection of AnexosDTO

None.

IdMunicipio

Código do município do local do fato. Identificador do IBGE para municípios. Seis dígitos. O IBGE por vezes mostra 7 dígitos, pois o último é um digito verificador. Informar apenas o município supre a necessidade de se informar SigUf.

integer

None.

GeoReferencia

Localização georeferencial do local do fato.

LocalizacaoDTO

None.

Envolvidos

Lista de envolvidos no fato.

Collection of EnvolvidosManifestacaoDTO

None.

IdCanalEntrada

Identificação do canal de entrada. Utilizado quando alguém registra uma manifestação feita em outro canal. Quando não preenchido representa o manifestante registrando sua própria manifestação. Neste caso, valor ‘Não Informado’ será apresentado em suas telas. Serviço que lista todos os canais possíveis disponível na documentação da API.

integer

None.

IdModoResposta

Identificação do modo de resposta a ser assumido pelo sistema. Quando não preenchido, o valor "Pelo sistema (com avisos por email)" será assumido por padrão. O serviço que lista todos os modos de resposta possíveis está disponível na documentação da API.

integer

None.

IdTipoIdentificacaoManifestante

* Obrigatório. Código da identificação do manifestante. O tipo anônimo só é permitido para denúncia e reclamação. Serviço que lista os tipos de identificação diponível na documentação da API.

integer

None.

Manifestante

Identificação do manifestante. Não é necessário informar se tipo de identificação for anônimo.

DadosInclusaoPessoaDTO

None.

DadosExtraJson

Informações adicionais em formato JSON que podem ser informados e posteriormente lidos por uma aplicação.

Collection of Object

None.

IndEnviarEmailCidadao

Se True, o e-OUV enviará e-mail ao manifestante, notificando o cadastro. Se False, o e-OUV considera que o sistema de origem fará a comunicação com o manifestante, evitando, assim, mensagens duplicadas. O padrão (default) é False.

boolean

None.

IndEnviarEmailOuvidoria

Se True e se a ouvidoria está configurada para receber notificação de novos cadastros, o e-OUV enviará e-mail à Ouvidoria destinatária, notificando o cadastro. Se False, o e-OUV considera que o sistema de origem fará a comunicação com à ouvidoria, evitando, assim, mensagens duplicadas. O padrão (default) é False.

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "NumProtocolo": "sample string 1",
  "IdTipoFormulario": 2,
  "IdTipoManifestacao": 3,
  "IdOuvidoriaDestino": 4,
  "IdOrgaoDestinatario": 5,
  "CodServicoMPOG": 1,
  "TxtOutroServico": "sample string 6",
  "IdAssunto": 1,
  "TextoManifestacao": "sample string 7",
  "PropostaMelhoria": "sample string 8",
  "Anexos": [
    {
      "NomeArquivo": "sample string 1",
      "ConteudoZipadoEBase64": "sample string 2",
      "TamanhoArquivo": 3
    },
    {
      "NomeArquivo": "sample string 1",
      "ConteudoZipadoEBase64": "sample string 2",
      "TamanhoArquivo": 3
    }
  ],
  "IdMunicipio": 1,
  "GeoReferencia": {
    "Latitude": 1.1,
    "Longitude": 2.1
  },
  "Envolvidos": [
    {
      "Nome": "sample string 1",
      "Orgao": "sample string 2",
      "IdFuncaoEnvolvidoManifestacao": 1
    },
    {
      "Nome": "sample string 1",
      "Orgao": "sample string 2",
      "IdFuncaoEnvolvidoManifestacao": 1
    }
  ],
  "IdCanalEntrada": 1,
  "IdModoResposta": 1,
  "IdTipoIdentificacaoManifestante": 9,
  "Manifestante": {
    "IdTipoPessoa": 1,
    "IdPais": 1,
    "IdTipoDocumentoIdentificacao": 1,
    "NumeroDocumentoIdentificacao": "sample string 2",
    "Nome": "sample string 3",
    "Email": "sample string 4",
    "DataNascimento": "2019-10-18T13:22:20.6036873-03:00",
    "Telefone": {
      "Numero": "sample string 1",
      "ddd": "sample string 2"
    },
    "CEP": "sample string 5",
    "IdMunicipio": 1,
    "Logradouro": "sample string 6",
    "Numero": "sample string 7",
    "Complemento": "sample string 8",
    "Bairro": "sample string 9",
    "genero": "sample string 10",
    "IdRacaCor": 1,
    "IdProfissao": 1,
    "IdEscolaridade": 1,
    "RazaoSocial": "sample string 11",
    "IdTipoInstituicao": 1,
    "IdAreaAtuacao": 1,
    "NomeRepresentante": "sample string 12",
    "CargoRepresentante": "sample string 13",
    "EmailRepresentante": "sample string 14"
  },
  "DadosExtraJson": null,
  "IndEnviarEmailCidadao": true,
  "IndEnviarEmailOuvidoria": true
}

text/html

Sample:
{"NumProtocolo":"sample string 1","IdTipoFormulario":2,"IdTipoManifestacao":3,"IdOuvidoriaDestino":4,"IdOrgaoDestinatario":5,"CodServicoMPOG":1,"TxtOutroServico":"sample string 6","IdAssunto":1,"TextoManifestacao":"sample string 7","PropostaMelhoria":"sample string 8","Anexos":[{"NomeArquivo":"sample string 1","ConteudoZipadoEBase64":"sample string 2","TamanhoArquivo":3},{"NomeArquivo":"sample string 1","ConteudoZipadoEBase64":"sample string 2","TamanhoArquivo":3}],"IdMunicipio":1,"GeoReferencia":{"Latitude":1.1,"Longitude":2.1},"Envolvidos":[{"Nome":"sample string 1","Orgao":"sample string 2","IdFuncaoEnvolvidoManifestacao":1},{"Nome":"sample string 1","Orgao":"sample string 2","IdFuncaoEnvolvidoManifestacao":1}],"IdCanalEntrada":1,"IdModoResposta":1,"IdTipoIdentificacaoManifestante":9,"Manifestante":{"IdTipoPessoa":1,"IdPais":1,"IdTipoDocumentoIdentificacao":1,"NumeroDocumentoIdentificacao":"sample string 2","Nome":"sample string 3","Email":"sample string 4","DataNascimento":"2019-10-18T13:22:20.6036873-03:00","Telefone":{"Numero":"sample string 1","ddd":"sample string 2"},"CEP":"sample string 5","IdMunicipio":1,"Logradouro":"sample string 6","Numero":"sample string 7","Complemento":"sample string 8","Bairro":"sample string 9","genero":"sample string 10","IdRacaCor":1,"IdProfissao":1,"IdEscolaridade":1,"RazaoSocial":"sample string 11","IdTipoInstituicao":1,"IdAreaAtuacao":1,"NomeRepresentante":"sample string 12","CargoRepresentante":"sample string 13","EmailRepresentante":"sample string 14"},"DadosExtraJson":null,"IndEnviarEmailCidadao":true,"IndEnviarEmailOuvidoria":true}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'Newtonsoft.Json.Linq.JToken' is a recursive collection data contract which is not supported. Consider modifying the definition of collection 'Newtonsoft.Json.Linq.JToken' to remove references to itself.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'Newtonsoft.Json.Linq.JToken' is a recursive collection data contract which is not supported. Consider modifying the definition of collection 'Newtonsoft.Json.Linq.JToken' to remove references to itself.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DadosInclusaoManifestacaoDTO'.

Response Information

Resource Description

ResultadoInclusaoManifestacaoDTO
NameDescriptionTypeAdditional information
IdManifestacao

Id da Manifestação Criada

integer

None.

NumeroProtocolo

Número de Protocolo da Manifestação criada

string

None.

CodigoAcesso

Código de Acesso da Manifestação criada

string

None.

Links

Links relacionados à manifestação.

Collection of LinkDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "IdManifestacao": 1,
  "NumeroProtocolo": "sample string 2",
  "CodigoAcesso": "sample string 3",
  "Links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    }
  ]
}

text/html

Sample:
{"IdManifestacao":1,"NumeroProtocolo":"sample string 2","CodigoAcesso":"sample string 3","Links":[{"rel":"sample string 1","href":"sample string 2"},{"rel":"sample string 1","href":"sample string 2"}]}

application/xml, text/xml

Sample:
<ResultadoInclusaoManifestacaoDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ouvidorias.Forms.Api.Models.DTO">
  <CodigoAcesso>sample string 3</CodigoAcesso>
  <IdManifestacao>1</IdManifestacao>
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Ouvidorias.Api.Models.DTO">
    <d2p1:LinkDTO>
      <d2p1:href>sample string 2</d2p1:href>
      <d2p1:rel>sample string 1</d2p1:rel>
    </d2p1:LinkDTO>
    <d2p1:LinkDTO>
      <d2p1:href>sample string 2</d2p1:href>
      <d2p1:rel>sample string 1</d2p1:rel>
    </d2p1:LinkDTO>
  </Links>
  <NumeroProtocolo>sample string 2</NumeroProtocolo>
</ResultadoInclusaoManifestacaoDTO>