Base de Conhecimento de Gestão Comercial de Saneamento

Essa página está em modo somente de leitura. Você pode visualizar a fonte, mas não alterá-la. Informe-se com o administrador do Wiki, caso você ache que isso está incorreto.
{{:ajuda:logo-gsan3.png?90}}

<code>
\\  ====== WebService Inserir Registro de Atendimento  ======

</code>

<columns> O WebService recebe apenas requisições do tipo **POST**.

Ele espera os seguintes Parâmetros:

  - key, //String//  contendo a chave de autenticação da empresa.
  - unidadeAtendimento, //Integer//  id da unidade de atendimento do Registro de Atendimento a ser Criado.
  - nomeSolicitante, //String//, contendo o nome do solicitante.
  - emailSolicitante, //String//  contendo o email do solicitante.
  - cpfCnpj, //String//cpf ou cnpj do solicitante.
  - telefoneSolicitante, //String//  telefone do solicitante.
  - matriculaImovel, //Integer//  matrícula do imóvel.
  - municipio, //Integer//  id do município do imóvel ou do lugar da ocorrência.
  - logradouro, //Integer//  id do logradouro do registro de atendimento.
  - bairro, //Integer//  id do Bairro do registro de atendimento.
  - cep, //String//  cep do logradouro do registro de atendimento.
  - numero, //String//  número do imóvel.
  - localidade, //String//  id da localidade da ocorrência.
  - latitude, //String//  Latitude do imóvel.
  - longitude, //String//  longitude do imóvel.
  - pavimentoRua, //String//  id do tipo de pavimento da rua do local da ocorrência.
  - pavimentoCalcada, //String//  do tipo de pavimento da calçada do local da ocorrência.
  - tipoEspecificacao, //String//  id do tipo da especificação do Registro de Atendimento a ser aberto.
  - pontoReferencia, //String//  descrição textual de um ponto de referência com no máximo 60 caracteres.
  - observacao, //String//  observação textual sobre o Registro de Atendimento a ser aberto com no máximo 380 caracteres.
  - meioSolicitacao, //Integer//  id do meio de Solicitação pelo qual o Registro de Atendimento foi aberto. APENAS NA VERSÃO ESTADUAL.
  - fotografiasBase64, //Array//  de arquivos no formato jpg, png ou pdf que serão anexados no Registro de Atendimento a ser aberto.

<code>
\\    * **Observação**, a validação dos campos depende das informações que são recebidas, devido a possibildiade de se abrir um Registro de Atendimento sem imóvel ou os campos latitude/longitude que só são obrigatórios caso um deles seja informado, por exemplo. Mais detalhes podem ser obtidos em  **[[postgres:integracao:uc1840|[UC1840 - Inserir Registro de Atendimento via webservice]]]**. \\ \\ Somente os campos abaixo, é que são considerados obrigatórios e validados em casa requisição:
  - Unidade de Atendimento
  - Nome do Solicitante
  - CPF/CNPJ do Solicitante
  - Pavimento da Rua
  - Pavimento da Calçada
  - Tipo da Especificação
\\  ===== Exemplo de Requisição para o Sistema =====

</code>

com os seguintes Dados:

|**Campo** |**Valor** |
|key|Abc123|
|bairro|9|
|tipoEspecificacao|1143|
|logradouro|1515|
|municipio|810|
|numero|2-218|
|observacao|observações|
|nomeSolicitante|João Silva|
|emailSolicitante|teste@teste.com|
|cpfCnpj|08712376589|
|telefoneSolicitante|0819963229933|
|unidadeAtendimento|1000135|
|pavimentoRua|0|
|pavimentoCalcada|0|
|matriculaImovel|1366021|
|meioSolicitacao|1|

===== A URL de Requisição Seria =====

//<URL_SERVIDOR_GSAN>/gsan/inserirRegistroAtendimento//

===== Exemplo de JSON Esperado =====

<code javascript>
{
   "key":"Abc123",
   "bairro":9,
   "tipoEspecificacao":1143,
   "logradouro":1515,
   "municipio":810,
   "numero":"2-218",
   "observacao":"observações",
   "pontoReferencia":"ponto de referência",
   "nomeSolicitante": "João Silva",
   "emailSolicitante": "teste@teste.com",
   "cpfCnpj": "08712376589",
   "telefoneSolicitante": "081996339922"
   "unidadeAtendimento":1000135,
   "pavimentoRua":0,
   "pavimentoCalcada":0,
   "matriculaImovel":1366021,
   "meioSolicitacao": 1
}


</code>

===== Retorno em Caso de Sucesso =====

<code javascript>
{
   "msg": "RA inserido com sucesso!",
   "registroAtendimento": "5686192",
   "ordemServico": "10261467",
   "dataPrevistaAtendimento": "24/05/2020",
   "numeroProtocolo": "20201006356531"
}


</code>

===== Retorno em Caso de Erro =====

<code javascript>
{
   "error": 1,
    "msg": "CPF/CNPJ do solicitante não é válido"
}


</code>

Clique **[[:treinamentos:integracoes|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações.