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-emitir-extrato-parcelamento-avista-codigo-barras

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
integracoes:web-services-emitir-extrato-parcelamento-avista-codigo-barras [29/09/2025 14:48] – [Web Service Emitir Extrado de Parcelamento à vista Código de Barras] jefferson.araujointegracoes:web-services-emitir-extrato-parcelamento-avista-codigo-barras [29/09/2025 18:43] (atual) – ajuste jefferson.araujo
Linha 1: Linha 1:
-{{ajuda:logo-gsan3.png?90|}}+{{:ajuda:logo-gsan3.png?90}}
  
-{{ajuda:logo-gsan3.png?90|}}+====== Web Service Emitir Extrato de Parcelamento à vista Código de Barras(Municipal) ======
  
-====== Web Service Emitir Extrado de Parcelamento à vista Código de Barras(Municipal) ======+<columns> O WebService recebe apenas requisições do tipo **GET**, e os parâmetros são passados via Query Parameter. Precisa autenticar passando uma key via header. Presente apenas na versão municipal. </columns>
  
-<columns> +<columns> São esperados os seguintes parâmetros:
-O WebService recebe apenas requisições do tipo **GET**, e os parâmetros são passados via Query Parameter. Precisa autenticar passando uma key via header. Presente apenas na versão municipal.  +
-</columns>+
  
-<columns> +|**Parâmetro** |**Valor** |**Tipo** | 
-São esperados os seguintes parâmetros:+|matricula|Matrícula do Imóvel|String| 
 +|resolucaoDiretoria|Resolução de diretoria. Opcional, se não informado usará um default.|String|
  
-|**Parâmetro** | **Valor** | **Tipo** | +<columns> É esperado o seguinte Header:
-|matricula| Matrícula do Imóvel|String| +
-|resolucaoDiretoria| Resolução de diretoria (opcional)|String| +
-   +
-</columns>+
  
-<columns> +|**Header** |**Valor** |**Tipo** | 
-São esperados o seguinte Header: +|key|Chave de autenticação|String|
- +
-|**Header** | **Valor** | **Tipo** | +
-|key| Chave de autenticação |String| +
-   +
-</columns>+
  
 == Exemplo de Requisição == == Exemplo de Requisição ==
 <code> <code>
 +
 https://<URL_GSAN>:<porta>/gsan/chatbot/emitirExtratoParcelamentoAVistaCodigoBarras?matricula=99999&resolucaoDiretoria=99 https://<URL_GSAN>:<porta>/gsan/chatbot/emitirExtratoParcelamentoAVistaCodigoBarras?matricula=99999&resolucaoDiretoria=99
 +
 </code> </code>
  
 == Retornos == == Retornos ==
-<columns> + 
- Com sucesso:+<columns> Com sucesso:
  
 <code javascript> <code javascript>
Linha 43: Linha 35:
     }     }
 } }
 +
 </code> </code>
- 
  
 Com erro: Com erro:
Linha 57: Linha 49:
     }     }
 } }
 +
 </code> </code>
- 
  
 Com erro de autenticação: Com erro de autenticação:
Linha 64: Linha 56:
 <code javascript> <code javascript>
 {"error":{"detailMessage":"Chave não autorizada"}} {"error":{"detailMessage":"Chave não autorizada"}}
 +
 </code> </code>
 +
 </columns> </columns>
  
 == Possíveis Códigos de Retorno == == Possíveis Códigos de Retorno ==
  
-| **Código** | **Mensagem** +|**Código** | | 
-|200 | "OK"+|200|"OK"
-|401 | "Unauthorized"+|401|"Unauthorized"
-|500 | "Internal Server Error"+|500|"Internal Server Error"
-== Possíveis Códigos de Retorno ==+ 
  
-| **Código** | **Mensagem** 
-|200 | "OK"| 
-|500 | "Internal Server Error"| 
integracoes/web-services-emitir-extrato-parcelamento-avista-codigo-barras.1759157331.txt.gz · Última modificação: 29/09/2025 14:48 por jefferson.araujo