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

WebService Acompanhamento de Registro de Atendimento

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. value, String contendo a matrícula do imóvel que se pretende pesquisar.


Exemplo de requisição para o sistema

Com as seguintes informações:

IP192.168.64.111
Chave de autenticaçãoaBC123DEF
Matrícula6093646


A Requisição Seria

Retorno em Caso de Sucesso

{
"key": (String) chave de autenticação recebida pelo WebService,
"qtd": (Integer) quantidade de registros retornados,
"resultado": [
{
"a": (String) Id do registro de Atendimento,
"b": (String) Número do protocolo,
"c": (String) Descrição da Soliticação Especificação Tipo,
"d": (String) Data de atendimento do registro de atendimento no formato dd/MM/yyyy,
"e": (String) Descrição da situação do registro de atendimento,
"f": (String) Data de encerramento do registro de atendimento no formato dd/MM/yyyy (Se houver),
"g": (String) Descrição do motivo de encerramento do Registro de Atendimento (Se houver)
}


Exemplo:


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.txt · Última modificação: 13/03/2020 14:24 por diego.ferreira