Base de Conhecimento de Gestão Comercial de Saneamento

Essa página está em modo somente de leitura. Você pode visualizar a fonte, mas não alterá-la. Informe-se com o administrador do Wiki, caso você ache que isso está incorreto.
{{ajuda:logo-gsan3.png?90|}}


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

<columns>
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:
  - key, //String// contendo a chave de autenticação da empresa.
  - protocolo, //String// contendo o número do protocolo que se pretende pesquisar.
  - id do registro de atendimento, //String// contendo o número do protocolo que se pretende pesquisar.
</columns>
\\

===== Exemplo de requisição para o sistema =====

Com as seguintes informações:
|IP|192.168.64.111|
|Chave de autenticação|aBC123DEF|
|protocolo|20181201705345|

\\

===== A Requisição Seria =====

http://192.168.64.111:8080/gsan/acompanharRAProtocolo?key=aBC123DEF&protocolo=20181201705345

\\

===== Exemplo de requisição para o sistema =====

Com as seguintes informações:
|IP|192.168.64.111|
|Chave de autenticação|aBC123DEF|
|registroAtendimento|100479438|

\\

===== A Requisição Seria =====

http://192.168.64.111:8080/gsan/acompanharRAProtocolo?key=aBC123DEF&registroAtendimento=100479438

\\

===== Retorno em Caso de Sucesso =====

<code javascript>
{
"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)
"idOsBloqueio": (String) Id da Ordem de Serviço do Bloqueio do Registro de Atendimento (Se houver)
"descricaoMotivoBloqueioOS": (Descrição do Motivo Bloqueio do Registro de Atendimento (Se houver))
}


</code>


===== Retorno em Caso de erro =====
<code javascript>
{
	"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
}
</code>

**Exemplo**:

\\
<WRAP center round box 100%>
{{  :integracoes:acomp_ra_json_2.jpg?nolink  |}}
</WRAP>

\\

===== Possíveis Códigos de Retorno =====
|Código|Mensagem|
|400|"parâmetros inválidos"|
|401|"chave inválida"|
|404|"A consulta não trouxe resultados"|
|500|“”|
\\

Clique **[[=treinamentos:integracoes|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações.