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: • prf • api
postgres:boto-nlp:api

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
postgres:boto-nlp:api [19/07/2022 17:19] – tadeu.sarmentopostgres:boto-nlp:api [02/08/2022 16:18] (atual) – tadeu.sarmento
Linha 1: Linha 1:
-<WRAP center round todo 60%> 
-Em obra 
-</WRAP> 
- 
 {{:postgres:boto-nlp:tatodesk_marca_05.png?nolink&250 |}} \\ \\ {{:postgres:boto-nlp:tatodesk_marca_05.png?nolink&250 |}} \\ \\
  
Linha 14: Linha 10:
 <columns> <columns>
 Escolha abaixo o serviço que deseja ver a **A.P.I** de integração: Escolha abaixo o serviço que deseja ver a **A.P.I** de integração:
 +  - **[[=postgres:boto-nlp:api#validacao_integracao_-_status|Validação / Integração - Status]]**
   - **[[=postgres:boto-nlp:api#login_autenticacao|Login/Autenticação]]**   - **[[=postgres:boto-nlp:api#login_autenticacao|Login/Autenticação]]**
   - **[[=postgres:boto-nlp:api#segunda_via_de_contas|Segunda Via de Contas]]**   - **[[=postgres:boto-nlp:api#segunda_via_de_contas|Segunda Via de Contas]]**
Linha 20: Linha 17:
 </columns> </columns>
 \\ \\
 +===== Validação/Integração - Status =====
 +<columns>
 +**A.P.I** responsável por informar se o sistema comercial está online e apto a receber requisições.
 +</columns>
 +\\
 +
 +==== GET /gsan/verificarBot ====
 +<columns>
 +**A.P.I** para obter o status do serviço do sistema comercial.
 +
 +\\
 +
 +**Resposta esperada**:
 +
 +  - **body**: valor booleano
 +\\
 +
 +Exemplo:
 +</columns>
 +
 +<WRAP center round box 100%>
 +{{  :postgres:boto-nlp:11111.jpg?nolink  |}}
 +<html><center> Figura 1 exemplo de request para a rota /gsan/verificarBot</center></html>
 +</WRAP>
 +\\
 +
  
 ===== Login/Autenticação ===== ===== Login/Autenticação =====
Linha 37: Linha 60:
  
 **Resposta esperada**: **Resposta esperada**:
-    - //body//: Objeto **JSON** com as seguintes informações: +    - **body**: Objeto **JSON** com as seguintes informações: 
-      - //localidade//: Identificador da localidade do imóvel. +      - **localidade**: Identificador da localidade do imóvel. 
-      - //setor//: Identificador do setor comercial do imóvel. +      - **setor**: Identificador do setor comercial do imóvel. 
-      - // quadra//: Identificador da quadra do imóvel.+      - **quadra**: Identificador da quadra do imóvel.
 \\ \\
  
Linha 48: Linha 71:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_1.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_1.jpg?nolink  |}}
-<html><center> Figura 1 Exemplo de request para a rota /gsan/localidadeImovel</center></html>+<html><center> Figura 2 Exemplo de request para a rota /gsan/localidadeImovel</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 56: Linha 79:
 **A.P.I** para obter imóveis associados a um CPF/CNPJ. Parâmetros: **A.P.I** para obter imóveis associados a um CPF/CNPJ. Parâmetros:
  
-**cpfCnpj**: +**cpfCnpj**: valor inteiro com a identificação do imóvel no sistema comercial.
-  - Valor inteiro com a identificação do imóvel no sistema comercial.+
 \\ \\
  
 **Resposta esperada**: **Resposta esperada**:
-    - //body//: Lista de objetos **JSON** com as seguintes informações: +    - **body**: Lista de objetos **JSON** com as seguintes informações: 
-      - //matriculaImovel//: Identificador do imóvel no sistema comercial. +      - **matriculaImovel**: Identificador do imóvel no sistema comercial. 
-      - //nomeCliente//: Nome do cliente. +      - **nomeCliente**: Nome do cliente. 
-      - //enderecoImovel//: Endereço do imóvel. +      - **enderecoImovel**: Endereço do imóvel. 
-      - //idCliente//: Identificador do cliente. +      - **idCliente**: Identificador do cliente. 
-      - //diaVencimentoImovel//: Dia do vencimento das contas do imóvel.+      - **diaVencimentoImovel**: Dia do vencimento das contas do imóvel.
  
 \\ \\
Linha 74: Linha 96:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_2.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_2.jpg?nolink  |}}
-<html><center> Figura 2 Exemplo de request para a rota /gsan/buscarImoveis</center></html>+<html><center> Figura 3 Exemplo de request para a rota /gsan/buscarImoveis</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 82: Linha 104:
 **A.P.I** para checar se um **CPF/CNPJ** está associado à matrícula informada. Parâmetros: **A.P.I** para checar se um **CPF/CNPJ** está associado à matrícula informada. Parâmetros:
  
-**matricula**: +  - **matricula**: valor inteiro com a identificação do imóvel no sistema comercial. 
-  - Valor inteiro com a identificação do imóvel no sistema comercial. +  - **cpfCnpj**: string com o número do **CPF/CNPJ** sem formatação. 
-\\ +
-**cpfCnpj**: +
-  - string com o número do **CPF/CNPJ** sem formatação.+
 \\ \\
 **Resposta esperada**: **Resposta esperada**:
-  - //body//: Objeto **JSON** com os campos abaixo: +  - **body**: Objeto **JSON** com os campos abaixo: 
-    - //cpfCnpjValido//: Valor booleano, que indica se o CPF/CNPJ informado é válido ou não. +    - **cpfCnpjValido**: Valor booleano, que indica se o CPF/CNPJ informado é válido ou não. 
-    - //matriculaValida//: Valor booleano, o qual indica se a matrícula informada corresponde a um valor válido no sistema comercial. +    - **matriculaValida**: Valor booleano, o qual indica se a matrícula informada corresponde a um valor válido no sistema comercial. 
-    - //matriculaExistente//: Valor booleano, com o indicativo se existe imóvel com a matrícula informada. +    - **matriculaExistente**: Valor booleano, com o indicativo se existe imóvel com a matrícula informada. 
-    - //cpfCnpjVinculados//: Indica se o CPF/CNPJ e matrícula informados estão associados.+    - **cpfCnpjVinculados**: Indica se o CPF/CNPJ e matrícula informados estão associados.
  
 \\ \\
Linha 101: Linha 121:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_3.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_3.jpg?nolink  |}}
-<html><center> Figura 3: Exemplo de request para a rota /gsan/verificarMatriculaCpfCnpj</center></html>+<html><center> Figura 4: Exemplo de request para a rota /gsan/verificarMatriculaCpfCnpj</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 108: Linha 128:
 **A.P.I** para checar se uma matrícula possui um valor válido no sistema comercial. Parâmetros: **A.P.I** para checar se uma matrícula possui um valor válido no sistema comercial. Parâmetros:
  
-**matricula**: +**matricula**: valor inteiro com a identificação do imóvel no sistema comercial.
-  - Valor inteiro com a identificação do imóvel no sistema comercial.+
  
 \\ \\
 **Resposta esperada 1**: **Resposta esperada 1**:
-  - //body//: Matrícula do imóvel:+  - **body**: Matrícula do imóvel:
 \\ \\
  
Linha 120: Linha 139:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_4.1.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_4.1.jpg?nolink  |}}
-<html><center> Figura 4.1: Exemplo de request para a rota /gsan/chatbot/autenticarMatricula</center></html>+<html><center> Figura 5.1: Exemplo de request para a rota /gsan/chatbot/autenticarMatricula</center></html>
 </WRAP> </WRAP>
  
Linha 135: Linha 154:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_4.2.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_4.2.jpg?nolink  |}}
-<html><center> Figura 4.2: Exemplo de request para a rota /gsan/chatbot/autenticarMatricula</center></html>+<html><center> Figura 5.2: Exemplo de request para a rota /gsan/chatbot/autenticarMatricula</center></html>
 </WRAP> </WRAP>
  
-**Observação**: No exemplo **4.2** o código de status da resposta é **422**.+**Observação**: No exemplo **5.2** o código de status da resposta é **422**. 
 +\\
  
 ===== Segunda Via de Contas ===== ===== Segunda Via de Contas =====
Linha 150: Linha 170:
 **A.P.I** para listar as contas de uma matrícula. Parâmetros: **A.P.I** para listar as contas de uma matrícula. Parâmetros:
  
-**matricula**: +  - **matricula**: valor inteiro com a identificação do imóvel no sistema comercial. 
-  - Valor inteiro com a identificação do imóvel no sistema comercial. +  - **pagination**: valor inteiro referente à página do resultado da lista de contas. Opcional. Caso não seja informado, ou informado o valor **0**, são listados todos os débitos, sem paginação do resultado.
- +
-**pagination**: +
-  - Valor inteiro referente à página do resultado da lista de contas. Opcional. Caso não seja informado, ou informado o valor **0**, são listados todos os débitos, sem paginação do resultado.+
 \\ \\
  
 **Resposta esperada**: **Resposta esperada**:
-  - //body//: Objeto **JSON** contendo uma lista de objetos **JSON** com os seguintes campos: +  - **body**: Objeto **JSON** contendo uma lista de objetos **JSON** com os seguintes campos: 
-    - //data//: Mês/ano de referência da conta. +    - **data**: Mês/ano de referência da conta. 
-    - //valor//: Valor total da conta. +    - **valor**: Valor total da conta. 
-    - //idConta//: Identificador da conta.+    - **idConta**: Identificador da conta.
 \\ \\
  
Linha 168: Linha 185:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_5.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_5.jpg?nolink  |}}
-<html><center> Figura 5: Exemplo de request para a rota /gsan/segundaViaConta</center></html>+<html><center> Figura 6: Exemplo de request para a rota /gsan/segundaViaConta</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 176: Linha 193:
 **A.P.I** para obter a quantidade e o valor total das contas de uma matrícula. Parâmetros: **A.P.I** para obter a quantidade e o valor total das contas de uma matrícula. Parâmetros:
  
-**matricula**: +**matricula**: valor inteiro com a identificação do imóvel no sistema comercial.
-  - Valor inteiro com a identificação do imóvel no sistema comercial.+
  
  
Linha 183: Linha 199:
  
 **Resposta esperada**: **Resposta esperada**:
-  - //body//: Objeto **JSON**  contendo os campos abaixo: +  - **body**: Objeto **JSON**  contendo os campos abaixo: 
-    - //qntdContas//: Quantidade total de contas do imóvel. +    - **qntdContas**: Quantidade total de contas do imóvel. 
-    - //valor//: Valor total das contas do imóvel.+    - **valor**: Valor total das contas do imóvel.
          
 \\ \\
Linha 193: Linha 209:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_6.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_6.jpg?nolink  |}}
-<html><center> Figura 6: Exemplo de request para a rota /gsan/segundaViaContaTotal</center></html>+<html><center> Figura 7: Exemplo de request para a rota /gsan/segundaViaContaTotal</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 199: Linha 215:
 ==== GET /gsan/segundaViaCodigoBarra ==== ==== GET /gsan/segundaViaCodigoBarra ====
 <columns> <columns>
-**A.P.I** para obter os códigos de barras das contas informadas. Parâmetros:+**A.P.I** para obter os códigos de barra das contas informadas. Parâmetros:
  
-**matricula**: +  - **matricula**: valor inteiro com a identificação do imóvel no sistema comercial. 
-  - Valor inteiro com a identificação do imóvel no sistema comercial. +  - **idConta**: lista de strings com a identificação das contas.
-**idConta**: +
-  - Lista de strings com a identificação das contas.+
  
  
Linha 211: Linha 225:
 **Resposta esperada**: **Resposta esperada**:
  
-  - //body//: Objeto **JSON** contendo os campos abaixo: +  - **body**: Objeto **JSON** contendo os campos abaixo: 
-    - //mesAno//: Lista com mês/ano de referência das contas, na ordem em que foram informadas. +    - **mesAno**: Lista com mês/ano de referência das contas, na ordem em que foram informadas. 
-    - //valor//: Lista com os valores das contas, na ordem em que foram informadas. +    - **valor**: Lista com os valores das contas, na ordem em que foram informadas. 
-    - //codigoBarra//: Lista com os códigos de barra sem formatação, seguindo a ordem em que as contas foram informadas.+    - **codigoBarra**: Lista com os códigos de barra sem formatação, seguindo a ordem em que as contas foram informadas.
  
          
Linha 223: Linha 237:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_7.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_7.jpg?nolink  |}}
-<html><center> Figura 7: Exemplo de request para a rota /gsan/segundaViaCodigoBarra</center></html>+<html><center> Figura 8: Exemplo de request para a rota /gsan/segundaViaCodigoBarra</center></html>
 </WRAP> </WRAP>
  
Linha 232: Linha 246:
 **A.P.I** obter (ou enviar por e-mail) o PDF com as contas informadas. Parâmetros: **A.P.I** obter (ou enviar por e-mail) o PDF com as contas informadas. Parâmetros:
  
-**matricula**: +  - **matricula**: valor inteiro com a identificação do imóvel no sistema comercial. 
-  - Valor inteiro com a identificação do imóvel no sistema comercial. +  - **idConta**: lista de strings com a identificação das contas. 
-**idConta**: +  - **simplificada**: parâmetro opcional. Quando informado, emite a conta com o layout simplificado. Caso não seja informado, é emitido no layout padrão de conta. 
-  - Lista de strings com a identificação das contas. +  - **email**: string opcional com o e-mail para o qual as contas serão enviadas. Caso não seja informado, é retornado o **BLOB** do arquivo PDF; caso contrário, os arquivos são enviados para o e-mail informado.
-**simplificada**: +
-  - Parâmetro opcional. Quando informado, emite a conta com o layout simplificado. Caso não seja informado, é emitido no layout padrão de conta. +
-**email**: +
-  - string opcional com o e-mail para o qual as contas serão enviadas. Caso não seja informado, é retornado o **BLOB** do arquivo PDF; caso contrário, os arquivos são enviados para o e-mail informado.+
  
 \\ \\
Linha 245: Linha 255:
 **Resposta esperada 1**: com e-mail informado **Resposta esperada 1**: com e-mail informado
  
-  - //body//: //string// informando que o e-mail foi enviado.+  - **body**: //string// informando que o e-mail foi enviado.
  
  
Linha 254: Linha 264:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_8.1.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_8.1.jpg?nolink  |}}
-<html><center> Figura 8.1: Exemplo de request para a rota /gsan/segundaViaContaRelatorio com e-mail</center></html>+<html><center> Figura 9.1: Exemplo de request para a rota /gsan/segundaViaContaRelatorio com e-mail</center></html>
 </WRAP> </WRAP>
 +\\
  
 <columns> <columns>
 **Resposta esperada 2**: sem e-mail informado: **Resposta esperada 2**: sem e-mail informado:
-  - //body//: **BLOB** do arquivo PDF com **content-type: aplication/pdf**.+  - **body**: **BLOB** do arquivo PDF com **content-type: aplication/pdf**.
 \\ \\
  
Linha 266: Linha 277:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_8.2.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_8.2.jpg?nolink  |}}
-<html><center> Figura 8.2: Exemplo de request para a rota /gsan/segundaViaContaRelatorio sem e-mail</center></html>+<html><center> Figura 9.2: Exemplo de request para a rota /gsan/segundaViaContaRelatorio sem e-mail</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 273: Linha 284:
 ===== Abrir RA: Falta D’Água, Vazamento e Religação ===== ===== Abrir RA: Falta D’Água, Vazamento e Religação =====
 <columns> <columns>
-**A.P.I’s** responsáveis pela verificação e cadastramento de registros de atendimento (RA) por Falta de Água, Vazamento e Religação da ligação de água. Veja abaixo as rotas necessárias para a realização deste serviço:+**A.P.I’s** responsáveis pela verificação e cadastramento de Registros de Atendimento por Falta de Água, Vazamento e Religação da ligação de água. Segue abaixo as rotas **REST** para realização do fluxo:
 </columns> </columns>
  
Linha 283: Linha 294:
 **Campos do body**: **Campos do body**:
  
-**matricula**: +  - **matricula**: valor inteiro com a identificação do imóvel no sistema comercial. 
-  - Valor inteiro com a identificação do imóvel no sistema comercial. +  - **especificacao**: valor inteiro com a identificação da especificação do atendimento. 
- +\\
-**especificacao**: +
-  - Valor inteiro com a identificação da especificação do atendimento.+
  
 **Resposta esperada 1** (caso exista registro de atendimento pendente para a matrícula informada): **Resposta esperada 1** (caso exista registro de atendimento pendente para a matrícula informada):
-  - //body//: Objeto **JSON** com os campos abaixo citados: +  - **body**: Objeto **JSON** com os campos abaixo citados: 
-    - //protocolo//: Protocolo do registro de atendimento. +    - **protocolo**: Protocolo do registro de atendimento. 
-    - //dataPrevistaAtendimentoRA//: A data em que o registro de atendimento está previsto para ser atendido. +    - **dataPrevistaAtendimentoRA**: A data em que o registro de atendimento está previsto para ser atendido. 
-    - //status//: Texto informativo que a solicitação já se encontra cadastrada.+    - **status**: Texto informativo que a solicitação já se encontra cadastrada.
 Exemplo: Exemplo:
 </columns> </columns>
Linha 300: Linha 309:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_9.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_9.jpg?nolink  |}}
-<html><center> Figura 9.1: Exemplo de request para a rota /gsan/verficarRAWS com RA pendente</center></html>+<html><center> Figura 10.1: Exemplo de request para a rota /gsan/verficarRAWS com RA pendente</center></html>
 </WRAP> </WRAP>
 <columns> <columns>
 +\\
 +
 **Resposta esperada 2** (caso não exista registro de atendimento pendente para a matrícula informada): **Resposta esperada 2** (caso não exista registro de atendimento pendente para a matrícula informada):
-  - //error//: objeto **JSON** com os campos abaixo citados: +  - **error**: objeto **JSON** com os campos abaixo citados: 
-    - //detailtMessage//: mensagem do erro.+    - **detailtMessage**: mensagem do erro.
 </columns> </columns>
 \\ \\
Linha 311: Linha 322:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:9.2.jpg?nolink  |}} {{  :postgres:boto-nlp:9.2.jpg?nolink  |}}
-<html><center> Figura 9.2: Exemplo de request para a rota /gsan/verficarRAWS sem RA pendente</center></html>+<html><center> Figura 10.2: Exemplo de request para a rota /gsan/verficarRAWS sem RA pendente</center></html>
 </WRAP> </WRAP>
 +\\
 +
 <columns> <columns>
-**Observação**: No exemplo **9.2** o código de status da resposta é **422**.+**Observação**: No exemplo **10.2** o código de status da resposta é **422**.
 </columns> </columns>
 +
 \\ \\
 ==== GET /gsan/episodiosFaltaAgua ==== ==== GET /gsan/episodiosFaltaAgua ====
Linha 321: Linha 335:
 **A.P.I** para checar a existência de ocorrências de desabastecimento na região do imóvel. Parâmetros: **A.P.I** para checar a existência de ocorrências de desabastecimento na região do imóvel. Parâmetros:
  
-**matricula**: +**matricula**: valor inteiro com a identificação do imóvel no sistema comercial.
-  - Valor inteiro com a identificação do imóvel no sistema comercial.+
 \\ \\
 **Resposta esperada** **Resposta esperada**
-  - //body//: lista de objetos **JSON** com os campos especificados abaixo: +  - **body**: lista de objetos **JSON** com os campos especificados abaixo: 
-    - //idOcorrencia//: identificador da ocorrência operacional. +    - **idOcorrencia**: identificador da ocorrência operacional. 
-    - //ocorrencia//: descrição da ocorrência operacional. +    - **ocorrencia**: descrição da ocorrência operacional. 
-    - //ocorrenciaAbreviada//: descrição da ocorrência com no máximo 30 caracteres. +    - **ocorrenciaAbreviada**: descrição da ocorrência com no máximo 30 caracteres. 
-    - //dataHora//: data e hora da ocorrência, no formato DD/MM/YYYY HH:mi:ss. +    - **dataHora**: data e hora da ocorrência, no formato DD/MM/YYYY HH:mi:ss. 
-    - //previsão//: data e período da previsão de retomada do abastecimento. +    - **previsão**: data e período da previsão de retomada do abastecimento. 
-    - //areaAfetada//: descrição das áreas afetadas pela ocorrência. +    - **areaAfetada**: descrição das áreas afetadas pela ocorrência. 
-    - //areaAfetadaAbreviada//: descrição das áreas afetadas pela ocorrência, com no máximo 30 caracteres.+    - **areaAfetadaAbreviada**: descrição das áreas afetadas pela ocorrência, com no máximo 30 caracteres.
 \\ \\
 Exemplo: Exemplo:
Linha 340: Linha 353:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:kaufman2.jpg?nolink  |}} {{  :postgres:boto-nlp:kaufman2.jpg?nolink  |}}
-<html><center> Figura 10: Exemplo de request para a rota /gsan/episodiosFaltaAgua</center></html>+<html><center> Figura 11: Exemplo de request para a rota /gsan/episodiosFaltaAgua</center></html>
 </WRAP> </WRAP>
  
Linha 349: Linha 362:
 **A.P.I** para listar as especificações de um tipo de solicitação de atendimento. Parâmetros: **A.P.I** para listar as especificações de um tipo de solicitação de atendimento. Parâmetros:
  
-**tipoSolicitacao**: +**tipoSolicitacao**: valor inteiro com a identificação do tipo de solicitação.
-  - Valor inteiro com a identificação do tipo de solicitação.+
 \\ \\
  
 **Resposta esperada**: **Resposta esperada**:
-  - //body//: lista de objetos **JSON** contendo os campos abaixo: +  - **body**: lista de objetos **JSON** contendo os campos abaixo: 
-    - //id//: identificador da especificação do atendimento. +    - **id**: identificador da especificação do atendimento. 
-    - //descricao//: descrição da especificação.+    - **descricao**: descrição da especificação.
 \\ \\
 Exemplo: Exemplo:
Linha 364: Linha 376:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:kaufman3.jpg?nolink  |}} {{  :postgres:boto-nlp:kaufman3.jpg?nolink  |}}
-<html><center> Figura 11: Exemplo de request para a rota /gsan/tipoEspecificacaoRA</center></html>+<html><center> Figura 12: Exemplo de request para a rota /gsan/tipoEspecificacaoRA</center></html>
 </WRAP> </WRAP>
 +\\
 ==== POST /gsan/verificarExistenciaRAReligacao ==== ==== POST /gsan/verificarExistenciaRAReligacao ====
 <columns> <columns>
 **A.P.I** para checar se existe registro de atendimento de religação para o imóvel. Campos do body: **A.P.I** para checar se existe registro de atendimento de religação para o imóvel. Campos do body:
  
-**matricula**: +**matricula**: valor inteiro com a identificação do imóvel no sistema comercial.
-  - Valor inteiro com a identificação do imóvel no sistema comercial.+
 \\ \\
  
 **Resposta esperada 1**: **Resposta esperada 1**:
-  - //body//: objeto **JSON** com os campos abaixo citados: +  - **body**: objeto **JSON** com os campos abaixo citados: 
-    - //protocolo//: protocolo do registro de atendimento. +    - **protocolo**: protocolo do registro de atendimento. 
-    - //dataPrevistaAtendimentoRA//: a data em que o registro de atendimento está previsto para ser atendido. +    - **dataPrevistaAtendimentoRA**: a data em que o registro de atendimento está previsto para ser atendido. 
-    - //status//: texto informativo que a solicitação já se encontra cadastrada.+    - **status**: texto informativo que a solicitação já se encontra cadastrada.
 \\ \\
 Exemplo: Exemplo:
Linha 387: Linha 398:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:kaufman5.jpg?nolink  |}} {{  :postgres:boto-nlp:kaufman5.jpg?nolink  |}}
-<html><center> Figura 12.1 – Exemplo de request para a rota /gsan/verificarExistenciaRAReligacao</center></html>+<html><center> Figura 13.1 – Exemplo de request para a rota /gsan/verificarExistenciaRAReligacao</center></html>
 </WRAP> </WRAP>
 \\ \\
 +
 <columns> <columns>
 **Resposta esperada 2**: **Resposta esperada 2**:
-  - //error//: objeto **JSON** com os campos descritos abaixo: +  - **error**: objeto **JSON** com os campos descritos abaixo: 
-    - //mensagem//: mensagem indicando que não existe solicitação cadastrada para a matrícula.+    - **mensagem**: mensagem indicando que não existe solicitação cadastrada para a matrícula.
 </columns> </columns>
 \\ \\
Linha 399: Linha 411:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:kaufman13.jpg?nolink  |}} {{  :postgres:boto-nlp:kaufman13.jpg?nolink  |}}
-<html><center> Figura 12.2 – Exemplo 2 de request para a rota /gsan/verificarExistenciaRAReligacao</center></html>+<html><center> Figura 13.2 – Exemplo 2 de request para a rota /gsan/verificarExistenciaRAReligacao</center></html>
 </WRAP> </WRAP>
 \\ \\
 +
 <columns> <columns>
-**Observação**: No exemplo **12.2** o código de status da resposta é **422**.+**Observação**: No exemplo **13.2** o código de status da resposta é **422**.
 </columns> </columns>
  
Linha 411: Linha 424:
 **A.P.I** para checar se o imóvel ainda possui débito em atraso. Parâmetros: **A.P.I** para checar se o imóvel ainda possui débito em atraso. Parâmetros:
  
-**matrícula**: +**matrícula**: valor inteiro com a identificação do imóvel no sistema comercial.
-  - Valor inteiro com a identificação do imóvel no sistema comercial.+
 \\ \\
 **Resposta esperada**: **Resposta esperada**:
  
-  - //message//: mensagens de validação dos fluxos conforme descritos nas árvores conversacionais (ver: **https://www.gsan.com.br/doku.php?id=postgres:boto-nlp:abrir-ra:religacao)**. +  - **message**: mensagens de validação dos fluxos conforme descritos nas árvores conversacionais (ver: **https://www.gsan.com.br/doku.php?id=postgres:boto-nlp:abrir-ra:religacao)**. 
-  - //body//: objeto **JSON** com os campos abaixo: +  - **body**: objeto **JSON** com os campos abaixo: 
-    - //matricula//: valor inteiro com a identificação do imóvel no sistema comercial. +    - **matricula**: valor inteiro com a identificação do imóvel no sistema comercial. 
-    - //endereco//: endereço do imóvel. +    - **endereco** endereço do imóvel. 
-    - //cortado//: valor booleano indicador se o imóvel encontra-se cortado ou não. +    - **cortado**: valor booleano indicador se o imóvel encontra-se cortado ou não. 
-  - //débitos//: objeto **JSON** referente aos débitos originários do corte, caso possua, com os seguintes campos: +  - **débitos**: objeto **JSON** referente aos débitos originários do corte, caso possua, com os seguintes campos: 
-    - //contas//: lista de objetos **JSON** com os valores: +    - **contas**: lista de objetos **JSON** com os valores: 
-      - //id//: identificador da conta. +      - **id**: identificador da conta. 
-      - //referência//: mês/ano de referência da conta. +      - **referência**: mês/ano de referência da conta. 
-      - //valor//: valor total da conta. +      - **valor**: valor total da conta. 
-    - //guias//: lista de objetos **JSON** com os valores: +    - **guias**: lista de objetos **JSON** com os valores: 
-      - //id//: identificador da guia de pagamento. +      - **id**: identificador da guia de pagamento. 
-      - //referência//: mês/ano de referência da guia de pagamento. +      - **referência**: mês/ano de referência da guia de pagamento. 
-      - //valor//: valor total da guia de pagamento. +      - **valor**: valor total da guia de pagamento. 
-    - //débitos//: lista de objetos **JSON** com os valores: +    - **débitos**: lista de objetos **JSON** com os valores: 
-      - //id//: identificador do débito a cobrar. +      - **id**: identificador do débito a cobrar. 
-      - //referência//: mês/ano de referência do débito a cobrar. +      - **referência**: mês/ano de referência do débito a cobrar. 
-      - //valor//: valor total do débito a cobrar.+      - **valor**: valor total do débito a cobrar.
 \\ \\
 Exemplo: Exemplo:
Linha 442: Linha 454:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:13.1.jpg?nolink  |}} {{  :postgres:boto-nlp:13.1.jpg?nolink  |}}
-<html><center> Figura 13.1 – Exemplo de request para a rota /gsan/verificarDebitosImovel</center></html>+<html><center> Figura 14.1 – Exemplo de request para a rota /gsan/verificarDebitosImovel</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 453: Linha 465:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:13.2.jpg?nolink  |}} {{  :postgres:boto-nlp:13.2.jpg?nolink  |}}
-<html><center> Figura 13.2 – Exemplo 2 de request para a rota /gsan/verificarDebitosImovel</center></html>+<html><center> Figura 14.2 – Exemplo 2 de request para a rota /gsan/verificarDebitosImovel</center></html>
 </WRAP> </WRAP>
  
Linha 461: Linha 473:
 **A.P.I** para checar se o e-mail informado está vinculado ao cliente do imóvel. Parâmetros: **A.P.I** para checar se o e-mail informado está vinculado ao cliente do imóvel. Parâmetros:
  
-**matrícula**: +  - **matrícula**: valor inteiro com a identificação do imóvel no sistema comercial. 
-  - Valor inteiro com a identificação do imóvel no sistema comercial.+  - **email**: string com o e-mail para validação.
 \\ \\
  
-**email**: 
-  - String com o e-mail para validação. 
-\\ 
 **Resposta esperada**: **Resposta esperada**:
-  - //body//: valor booleano indicando se o e-mail informado está associado ao cliente do imóvel ou não.+  - **body**: valor booleano indicando se o e-mail informado está associado ao cliente do imóvel ou não.
 \\ \\
 Exemplo: Exemplo:
Linha 478: Linha 487:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:14.jpg?nolink  |}} {{  :postgres:boto-nlp:14.jpg?nolink  |}}
-<html><center> Figura 14 – Exemplo 2 de request para a rota /gsan/verificarEmailCadastrado</center></html>+<html><center> Figura 15 – Exemplo 2 de request para a rota /gsan/verificarEmailCadastrado</center></html>
 </WRAP> </WRAP>
 +\\
  
 +==== POST /gsan/inserirRAWS ====
 +<columns>
 +**A.P.I** para inserir o Registro de Atendimento.
  
 +**Campos do body**:
 +
 +  - **matrícula**: valor inteiro com a identificação do imóvel no sistema comercial.
 +  - **solicitacaoTipo**: valor inteiro, referente ao identificador do tipo de solicitação do atendimento.
 +  - **especificacao**: valor inteiro, referente ao identificador da especificação do atendimento.
 +  - **pontoReferencia**: descrição do ponto de referência.
 +  - **telefoneContato**: telefone de contato com o DDD, no formato (XX) DDDDD-DDDD.
 +  - **observacoes**: descrição da observação a ser associada ao Registro de Atendimento.
 +  - **nomeSolicitante**: nome do solicitante.
 +  - **email**: email do solicitante.
 \\ \\
-~~NOSIDEBAR~~+**Resposta esperada**
  
-~~ODT~~+  - **body**: objeto JSON com os campos abaixo: 
 +    - **protocolo**: número do protocolo de atendimento registrado. 
 +    - **dataPrevistaAtendimentoRA**: data prevista de realização do atendimento. 
 +    - **status**: texto informativo que a solicitação foi cadastrada. 
 +\\ 
 +Exemplo: 
 +</columns>
  
 +\\
  
 +<WRAP center round box 100%>
 +{{  :postgres:boto-nlp:15.jpg?nolink  |}}
 +<html><center> Figura 16 – Exemplo de request para a rota /gsan/inserirRAWS</html>
 +</WRAP>
 +\\
  
 +==== POST /gsan/inserirRAReligacao ====
 +<columns>
 +**A.P.I** para inserir o Registro de Atendimento de religação da ligação de água.
 +
 +**Campos do body**:
 +
 +  - **matricula**: valor inteiro com a identificação do imóvel no sistema comercial.
 +  - **pontoReferencia**: descrição do ponto de referência.
 +  - **telefoneContato**: telefone de contato com o DDD, no formato (XX) DDDDD-DDDD.
 +  - **email**: email do solicitante.
 +  - **tipoRegistroAtendimento**: valor constante 1.
 +\\
 +**Resposta esperada**
 +
 +  - **body**: objeto JSON com os campos abaixo:
 +    - **protocolo**: número do protocolo de atendimento registrado.
 +    - **dataPrevistaAtendimentoRA**: data prevista de realização do atendimento.
 +    - **status**: texto informativo que a solicitação foi cadastrada.
 +
 +\\
 +Exemplo:
 +</columns>
 +
 +\\
 +
 +<WRAP center round box 100%>
 +{{  :postgres:boto-nlp:16.jpg?nolink  |}}
 +<html><center> Figura 17 – Exemplo de request para a rota /gsan/inserirRAReligacao</html>
 +</WRAP>
 +
 +
 +
 +\\
 +Clique **[[=postgres:tatodesk|AQUI]]** para retornar.
 +~~NOSIDEBAR~~
 +\\
 +~~ODT~~
postgres/boto-nlp/api.1658251159.txt.gz · Última modificação: 19/07/2022 17:19 por tadeu.sarmento