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 Recepcionar Dados da OS - 156 ======

<columns>
O WebService recebe apenas requisições do tipo **POST**, e os parâmetros são passados via **JSON**.

Ele espera os seguintes Parâmetros:
  - key, //String// contendo a chave de autenticação da empresa.
  - idRA, //Inteiro// contendo o identificador da ordem de serviço.
  - protocolo, //String// contendo o protocolo da ordem de serviço.
  - servicoExecutado, //String// contendo o indicador de que o serviço foi executado. Podendo ser (1, "S" ou "SIM") para Serviço Executado ou (2, "N" ou "NAO") para Serviço Não Executado. Este campo não é case sensitive.
  - parecerEncerramento, //String// contendo o parecer de encerramento da ordem de serviço.
</columns>
\\

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

Com as seguintes informações:
|URL|http://evolutiva.consensotec.com.br:8106|
|key|hjTlR4f8lkP9B6mKs8W3yCPOTGsLn_Ej4TSmLbKyxiUEqYU4Fxn7k2V-DnF-TvnL|
|idRA|180|
|protocolo|000030-24-02|
|servicoExecutado|SIM|
|parecerEncerramento|SERVICO EXECUTADO COM SUCESSO 156|
\\

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

http://evolutiva.consensotec.com.br:8106/gsan/recepcionarDadosOS156WS

===== Envio - JSON  ===== 

<code javascript>
{
    "key": "hjTlR4f8lkP9B6mKs8W3yCPOTGsLn_Ej4TSmLbKyxiUEqYU4Fxn7k2V-DnF-TvnL",
    "idRA": 180,
    "protocolo": "000030-24-02",
    "servicoExecutado": "S",
    "parecerEncerramento": "SERVICO EXECUTADO COM SUCESSO 156"
}
</code>
\\

===== Retorno com Sucesso - JSON =====

<code javascript>
{
    "key": "hjTlR4f8lkP9B6mKs8W3yCPOTGsLn_Ej4TSmLbKyxiUEqYU4Fxn7k2V-DnF-TvnL",
    "body": "Dados da OS recebidos com sucesso."
}
</code>
\\

===== Retorno com Insucesso - JSON ===== 
<code javascript>
{
    "key": "hjTlR4f8lkP9B6mKs8W3yCPOTGsLn_Ej4TSmLbKyxiUEqYU4Fxn7k2V-DnF-TvnL",
    "error": {
        "parametrosMensagem": [],
        "detailMessage": "atencao.ordem_servico_nao_encontrada"
    }
}
</code>
\\

===== Possíveis Códigos de Retorno =====
|Código|Mensagem|Body
|200|"OK"|
|500|"Internal Server Error"|
|404|"Page not found"|
|422|"Unprocessable Entity"|

\\

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