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-estadual-inserir-regristro-atendimento-simplificado

WebService Estadual Inserir Registro Atendimento Simplificado

O WebService recebe apenas requisições do tipo POST, e os parâmetros são passados via Query Parameter.

Ele espera o seguinte Parâmetro:

  1. key, String contendo o id do imóvel.
  2. matricula, Int contendo matricula do imóvel.
  3. especificacao, String contendo a especificação do imóvel.
  4. pontoReferencia, String contendo a descrição do ponto de referência.
  5. email, String contendo o e-mail do cliente.
  6. cliente, Int contendo a código do cliente.
  7. localOcorrencia, String contendo o endereço da ocorrência.
  8. unidadeAtendimento, Int contendo o código da Unidade de Atendimento.
  9. nomeSolicitante, String contendo o nome do Solicitante do atendimento.
  10. telefone, String contendo o telefone do Solicitante do atendimento (apenas numeros).
  11. array de imagens, cada imagem possui dois campos
    1. id String contendo as URLs publicas dos anexos do Registro de atendimento a ser aberto.
    2. descricao String contendo a descrição da imagem.

Exemplo de requisição para o sistema

Com a seguinte informação:

keyAbc123
matricula21788766
especificacao4150
pontoReferenciaTeste ponto de referência
emailteste@teste.com.br
cliente26706610
localOcorrenciaLOTEAMENTO CAMPO GRANDE - 89 - J-37 - CANAFISTULA
nomeSolicitanteJosé Teste
telefone81987654321
imagem[{id: “https://message-file.tatodesk.net/public/file?token=VTJGc2RHVmtYMTkyZmt0Umcra3ZDNjEyUU94VFh2NWNyalhSM2JZTHA1TjRJaUNLSUg1MEpxVFZ0dXZnTU9XUlltVjNseGcrUkpyd3g1OXpxVjIyT1VHeW05dnpCTlJOYXdPNm5RSCsyVjFUcCtPNEE3K3RBcE1FZnAvdDJoVnc5K1dTeThWOU1KaGxmOVdhejgyUTJNcHlRclVMeU5vcStRaWNKUm1wc25nPQ==”, descricao : “logo tatoDesk”}, {imagemid: “https://saemja.jau.sp.gov.br/wp-content/uploads/2024/05/hidrometro1.jpg”, descricao : “foto do hidrometro”}]

Exemplo de requisição Seria

RAW

{
    "key":"Abc123",
    "matricula":"21788766",
    "especificacao" : "4150",
    "pontoReferencia" : "Teste ponto de referência",
    "email":"francisco.ferreira@consensotec.com.br",
    "cliente" : "26706610",
    "localOcorrencia": "LOTEAMENTO CAMPO GRANDE - 89 - J-37 - CANAFISTULA ",
    "unidadeAtendimento":"64230",
    "nomeSolicitante":"Francisco",
    "telefone": "81912345678",
    "imagem":[
    { id: "https://message-file.tatodesk.net/public/file?token=VTJGc2RHVmtYMTkyZmt0Umcra3ZDNjEyUU94VFh2NWNyalhSM2JZTHA1TjRJaUNLSUg1MEpxVFZ0dXZnTU9XUlltVjNseGcrUkpyd3g1OXpxVjIyT1VHeW05dnpCTlJOYXdPNm5RSCsyVjFUcCtPNEE3K3RBcE1FZnAvdDJoVnc5K1dTeThWOU1KaGxmOVdhejgyUTJNcHlRclVMeU5vcStRaWNKUm1wc25nPQ==", descricao : "logo tatoDesk"},
    { id: "https://saemja.jau.sp.gov.br/wp-content/uploads/2024/05/hidrometro1.jpg", descricao: "hidrometro"}]
 
}

Retorno com Sucesso

{
    "key": "Abc123",
    "body": {
        "emailInvalido": false,
        "especificacaoInvalida": false,
        "anexosNaoInformados": false,
        "registroAtendimentoInseridoComSucesso": true,
        "idRegistroAtendimento": 93284499,
        "dtRegistroAtendimento": "19/02/2025 11:11:33",
        "dataPrevistaAtendimentoRA": "01/03/2025 23:59:59",
        "protocolo": "20251003600068"
    }
}

No caso de Sucesso, são obtidos os seguintes parâmetros:

  1. id do Registro Atendimento;
  2. data do Registro Atendimento;
  3. data Prevista para o Atendimento RA;e
  4. protocolo;

Retorno em caso de Erro

{
    "key": "Abc123",
    "body": {
        "emailInvalido": false,
        "especificacaoInvalida": false,
        "anexosNaoInformados": true,
        "registroAtendimentoInseridoComSucesso": false
    }
}

Possíveis Códigos de Retorno

CódigoMensagem
200“OK”
500“Internal Server Error”
404“Page not found”
400“Email inválido”
integracoes/web-services-estadual-inserir-regristro-atendimento-simplificado.txt · Última modificação: 26/02/2025 11:18 por diego.ferreira