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-acompanhamento-ra-protocolo-id

WebService Acompanhamento de Registro de Atendimento por Protocolo ou Id do RA

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

Ele espera os seguintes Parâmetros:

  1. key, String contendo a chave de autenticação da empresa.
  2. protocolo, String contendo o número do protocolo que se pretende pesquisar.
  3. id do registro de atendimento, String contendo o número do protocolo que se pretende pesquisar.


Exemplo de requisição para o sistema

Com as seguintes informações:

IP192.168.64.111
Chave de autenticaçãoaBC123DEF
protocolo20181201705345


A Requisição Seria

Exemplo de requisição para o sistema

Com as seguintes informações:

IP192.168.64.111
Chave de autenticaçãoaBC123DEF
registroAtendimento100479438


A Requisição Seria

Retorno em Caso de Sucesso

{
"key": (String) chave de autenticação recebida pelo WebService,
"resultado": [
{
"idRegistroAtendimento": (String) Id do registro de Atendimento,
"tipoSolicitacao": (String) Número do protocolo,
"especificacao": (String) Descrição da Soliticação Especificação Tipo,
"dataAtendimento": (String) Data de atendimento do registro de atendimento no formato dd/MM/yyyy,
"situacao": (String) Descrição da situação do registro de atendimento,
"numeroProtocolo": (String) Número do protocolo , 
"dataEncerramento": (String) Data de encerramento do registro de atendimento no formato dd/MM/yyyy (Se houver),
"motivoEncerramento": (String) Descrição do motivo de encerramento do Registro de Atendimento (Se houver)
}
 
 

Retorno em Caso de erro

{
	"error": (Integer) Código de erro da requisição,
	"msg": (String) Mensagem indicando o que houve, ou vazio em caso de erro 500,
	"qtd": (Integer) sempre valor 0
}

Exemplo:



Possíveis Códigos de Retorno

CódigoMensagem
400“parâmetros inválidos”
401“chave inválida”
404“A consulta não trouxe resultados”
500“”


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

integracoes/web-services-acompanhamento-ra-protocolo-id.txt · Última modificação: 28/10/2022 20:34 por vivianne.sousa