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

Visitou: • gerencial
integracoes:web-services-estadual-inserir-regristro-atendimento-simplificado

Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

Link para esta página de comparações

Ambos lados da revisão anteriorRevisão anterior
Próxima revisão		Revisão anterior
integracoes:web-services-estadual-inserir-regristro-atendimento-simplificado [19/02/2025 14:19] – criação da documentação do webservice estadual Inserir Registro Atendimento Simplificado jefferson.barbosaintegracoes:web-services-estadual-inserir-regristro-atendimento-simplificado [26/02/2025 11:18] (atual) – diego.ferreira
Linha 2: Linha 2:
  
 <columns> O WebService recebe apenas requisições do tipo **POST**, e os parâmetros são passados via **Query Parameter**. <columns> O WebService recebe apenas requisições do tipo **POST**, e os parâmetros são passados via **Query Parameter**.
- 
-Ele possui os seguintes Headers: 
- 
-|Key|Value| 
-|client_id|testeAutoLeitura| 
-|client_secret|admin| 
  
 </columns> </columns>
Linha 15: Linha 9:
   - key, //String//  contendo o id do imóvel.   - key, //String//  contendo o id do imóvel.
   - matricula, //Int//  contendo matricula do imóvel.   - matricula, //Int//  contendo matricula do imóvel.
-  - especificacao, //String// contendo a especificação do imóvel. +  - especificacao, //String//  contendo a especificação do imóvel. 
-  - pontoReferencia, //String// contendo a descrição do ponto de referência. +  - pontoReferencia, //String//  contendo a descrição do ponto de referência. 
-  - email, //String// contendo o e-mail do cliente. +  - email, //String//  contendo o e-mail do cliente. 
-  - cliente, //Int// contendo a código do cliente. +  - cliente, //Int//  contendo a código do cliente. 
-  - localOcorrencia, //String// contendo o endereço da ocorrência. +  - localOcorrencia, //String//  contendo o endereço da ocorrência. 
-  - unidadeAtendimento, //Int// contendo o código da Unidade de Atendimento. +  - unidadeAtendimento, //Int//  contendo o código da Unidade de Atendimento. 
-  - nomeSolicitante, //String// contendo o nome do Solicitante do atendimento.  +  - nomeSolicitante, //String//  contendo o nome do Solicitante do atendimento. 
-  - telefone, //String// contendo o telefone do Solicitante do atendimento (apenas numeros). +  - telefone, //String//  contendo o telefone do Solicitante do atendimento (apenas numeros). 
-  - imagem, possui dois campos  +  - array de imagens, cada imagem possui dois campos 
-    -  id //String// contendo as URLs das imagens do Registro de atendimento. +      - id //String//  contendo as URLs publicas dos anexos do Registro de atendimento a ser aberto. 
-    -  descricao //String// contendo a descrição da imagem. +      - descricao //String//  contendo a descrição da imagem.
- +
-  +
  
 </columns> </columns>
- 
  
 ===== Exemplo de requisição para o sistema ===== ===== Exemplo de requisição para o sistema =====
Linha 36: Linha 27:
 Com a seguinte informação: Com a seguinte informação:
  
-|key |Abc123|+|key|Abc123|
 |matricula|21788766| |matricula|21788766|
 |especificacao|4150| |especificacao|4150|
Linha 42: Linha 33:
 |email|teste@teste.com.br| |email|teste@teste.com.br|
 |cliente|26706610| |cliente|26706610|
-|localOcorrencia|LOTEAMENTO CAMPO GRANDE - 89 - J-37 - CANAFISTULA |+|localOcorrencia|LOTEAMENTO CAMPO GRANDE - 89 - J-37 - CANAFISTULA|
 |nomeSolicitante|José Teste| |nomeSolicitante|José Teste|
 |telefone|81987654321| |telefone|81987654321|
-|imagem| id: "https://message-file.tatodesk.net/public/file?token=VTJGc2RHVmtYMTkyZmt0Umcra3ZDNjEyUU94VFh2NWNyalhSM2JZTHA1TjRJaUNLSUg1MEpxVFZ0dXZnTU9XUlltVjNseGcrUkpyd3g1OXpxVjIyT1VHeW05dnpCTlJOYXdPNm5RSCsyVjFUcCtPNEE3K3RBcE1FZnAvdDJoVnc5K1dTeThWOU1KaGxmOVdhejgyUTJNcHlRclVMeU5vcStRaWNKUm1wc25nPQ==", descricao : | +|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"}]|
-|imagem|id: "https://saemja.jau.sp.gov.br/wp-content/uploads/2024/05/hidrometro1.jpg", descricao : | +
  
 ===== Exemplo de requisição Seria ===== ===== Exemplo de requisição Seria =====
Linha 56: Linha 45:
  
 <code javascript> <code javascript>
-{  +{
     "key":"Abc123",     "key":"Abc123",
     "matricula":"21788766",     "matricula":"21788766",
Linha 67: Linha 56:
     "nomeSolicitante":"Francisco",     "nomeSolicitante":"Francisco",
     "telefone": "81912345678",     "telefone": "81912345678",
- "imagem":[  +    "imagem":[ 
- { id: "https://message-file.tatodesk.net/public/file?token=VTJGc2RHVmtYMTkyZmt0Umcra3ZDNjEyUU94VFh2NWNyalhSM2JZTHA1TjRJaUNLSUg1MEpxVFZ0dXZnTU9XUlltVjNseGcrUkpyd3g1OXpxVjIyT1VHeW05dnpCTlJOYXdPNm5RSCsyVjFUcCtPNEE3K3RBcE1FZnAvdDJoVnc5K1dTeThWOU1KaGxmOVdhejgyUTJNcHlRclVMeU5vcStRaWNKUm1wc25nPQ==", descricao : ""}, +    { 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: ""}] +    { id: "https://saemja.jau.sp.gov.br/wp-content/uploads/2024/05/hidrometro1.jpg", descricao: "hidrometro"}] 
- +
 } }
 +
  
 </code> </code>
  
 ===== Retorno com Sucesso ===== ===== Retorno com Sucesso =====
- 
- 
  
 <code javascript> <code javascript>
Linha 93: Linha 81:
     }     }
 } }
 +
  
 </code> </code>
  
 No caso de Sucesso, são obtidos os seguintes parâmetros: No caso de Sucesso, são obtidos os seguintes parâmetros:
 +
   - id do Registro Atendimento;   - id do Registro Atendimento;
   - data do Registro Atendimento;   - data do Registro Atendimento;
-  - data Prevista para o Atendimento RA;e +  - data Prevista para o Atendimento RA;e
   - protocolo;   - protocolo;
- 
  
 ===== Retorno em caso de Erro ===== ===== Retorno em caso de Erro =====
Linha 116: Linha 105:
 } }
  
-</code> 
  
 +</code>
  
 ===== Possíveis Códigos de Retorno ===== ===== Possíveis Códigos de Retorno =====
integracoes/web-services-estadual-inserir-regristro-atendimento-simplificado.1739974763.txt.gz · Última modificação: 19/02/2025 14:19 por jefferson.barbosa