Base de Conhecimento de Gestão Comercial de Saneamento

A maior base de documentação de GSAN do mercado mantida pela Consenso Tecnologia

Ferramentas do usuário

Ferramentas do site


integracoes:web-services-inserir-registro-atendimento


WebService Inserir Registro de Atendimento

O WebService recebe apenas requisições do tipo POST.

Ele espera os seguintes Parâmetros:

  1. key, String contendo a chave de autenticação da empresa.
  2. unidadeAtendimento, Integer id da unidade de atendimento do Registro de Atendimento a ser Criado.
  3. nomeSolicitante, String, contendo o nome do solicitante.
  4. emailSolicitante, String contendo o email do solicitante.
  5. cpfCnpj, Stringcpf ou cnpj do solicitante.
  6. telefoneSolicitante, String telefone do solicitante.
  7. matriculaImovel, Integer matrícula do imóvel.
  8. municipio, Integer id do município do imóvel ou do lugar da ocorrência.
  9. logradouro, Integer id do logradouro do registro de atendimento.
  10. bairro, Integer id do Bairro do registro de atendimento.
  11. cep, String cep do logradouro do registro de atendimento.
  12. numero, String número do imóvel.
  13. localidade, String id da localidade da ocorrência.
  14. latitude, String Latitude do imóvel.
  15. longitude, String longitude do imóvel.
  16. pavimentoRua, String id do tipo de pavimento da rua do local da ocorrência.
  17. pavimentoCalcada, String do tipo de pavimento da calçada do local da ocorrência.
  18. tipoEspecificacao, String id do tipo da especificação do Registro de Atendimento a ser aberto.
  19. pontoReferencia, String descrição textual de um ponto de referência com no máximo 60 caracteres.
  20. observacao, String observação textual sobre o Registro de Atendimento a ser aberto com no máximo 380 caracteres.
  21. meioSolicitacao, Integer id do meio de Solicitação pelo qual o Registro de Atendimento foi aberto.
  22. fotografiasBase64, Array de arquivos no formato jpg, png ou pdf que serão anexados no Registro de Atendimento a ser aberto.


  • 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 [UC1840 - Inserir Registro de Atendimento via webservice].

    Somente os campos abaixo, é que são considerados obrigatórios e validados em casa requisição:
    1. Unidade de Atendimento
    2. Nome do Solicitante
    3. CPF/CNPJ do Solicitante
    4. Pavimento da Rua
    5. Pavimento da Calçada
    6. Tipo da Especificação


Exemplo de Requisição para o Sistema

com os seguintes Dados:

Campo Valor
key Abc123
bairro 9
tipoEspecificacao1143
logradouro 1515
municipio 810
numero 2-218
observacao observações
nomeSolicitante João Silva
emailSolicitante teste@teste.com
cpfCnpj 08712376589
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

{  
   "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",
   "unidadeAtendimento":1000135,
   "pavimentoRua":0,
   "pavimentoCalcada":0,
   "matriculaImovel":1366021,
   "meioSolicitacao": 1
}

Retorno em Caso de Sucesso

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


Retorno em Caso de Erro

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


Clique AQUI para acessar outros serviços com os detalhes técnicos das integrações.

integracoes/web-services-inserir-registro-atendimento.txt · Última modificação: 02/06/2020 12:21 por diego.ferreira