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.
====== WebService Emitir Segunda Via Conta Relatório ======
\\
<columns> O WebService recebe apenas requisições do tipo **GET**, e os parâmetros são passados via **Query Parameter**. O WebService possui Quatro cenarios de secesso 
\\
====== No primeiro cenário ele espera os seguintes Parâmetros:======
\\
  - matrícula, //Integer//  valor inteiro com a identificação do imóvel no sistema comercial.
  - idConta, //String//  lista de strings com a identificação das contas.
  
</columns>
\\

Com as seguintes informações:
\\
|matricula|889067|
|idConta|["13668877","16724433"]|

===== ENDPOINT SEGUNDA VIA DE CONTA =====

[[http://ENDPOINTALVO:PORTA/gsan/segundaViaContaRelatorio?matricula=IDDOIMOVEL&idConta=%5B%IDDACONTA%22,%20%|http://ENDPOINTALVO:PORTA/gsan/segundaViaContaRelatorio?matricula=IDDOIMOVEL&idConta=%5B%IDDACONTA%22,%20%]]

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

\\
===== Exemplo: =====
\\
{{  :integracoes:exe01.png?nolink&  }}

\\
====== No Segundo cenário ele espera os seguintes Parâmetros:======

\\
<columns>

  - matrícula, //Integer//  valor inteiro com a identificação do imóvel no sistema comercial.
  - idConta, //String//  lista de strings com a identificação das contas.
  - 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.
  
</columns>

\\

Com as seguintes informações:

|matricula|889067|
|idConta|["13668877","16724433"]|
|simplificada|true|

\\
===== ENDPOINT SEGUNDA VIA DE CONTA SIMPLIFICADA=====

\\
[[http://ENDPOINTALVO:PORTAENDPOINTALVO:PORTA/gsan/segundaViaContaRelatorio?matricula=IDDOIMOVEL&idConta=%5B%IDDACONTA%22,%20%&simplificada=true|http://ENDPOINTALVO:PORTA/gsan/segundaViaContaRelatorio?matricula=IDDOIMOVEL&idConta=%5B%IDDACONTA%22,%20%&simplificada=true]]
\\
===== Retorno em Caso de Sucesso =====
\\

===== Exemplo: =====
\\

{{  :integracoes:exe02.png?nolink&  }}
\\

====== No terceiro cenário ele espera os seguintes Parâmetros:======
\\
<columns>
  - matrícula, //Integer//  valor inteiro com a identificação do imóvel no sistema comercial.
  - idConta, //String//  lista de strings com a identificação das contas.
  - 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// 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.

</columns>
\\
Com as seguintes informações:
\\
|matricula|889067|
|idConta|["13668877","16724433"]|
|simplificada|true|
|email| "teste@teste.consensocte.com.br"|

\\
===== ENDPOINT SEGUNDA VIA DE CONTA SIMPLIFICADA PARA EMAIL =====
\\
[[http://ENDPOINTALVO:PORTA/gsan/segundaViaContaRelatorio?matricula=IDDOIMOVEL&idConta=%5B%IDDACONTA%22,%20%&simplificada=true&email=%22teste%40teste.consensocte.com.br%22|http://ENDPOINTALVO:PORTA/gsan/segundaViaContaRelatorio?matricula=IDDOIMOVEL&idConta=%5B%IDDACONTA%22,%20%&simplificada=true&email=%22teste%40teste.consensocte.com.br%22]]

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

===== Exemplo: =====
\\
{{  :integracoes:exe03.png?nolink&  }}

\\
====== No Quarto cenário ele espera os seguintes Parâmetros:======
\\
<columns>
  - matrícula, //Integer//  valor inteiro com a identificação do imóvel no sistema comercial.
  - idConta, //String//  lista de strings com a identificação das contas.
  - email, //String// 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.

</columns>


\\
Com as seguintes informações:
\\
|matricula|889067|
|idConta|["13668877","16724433"]|
|email| "teste@teste.consensocte.com.br"|
\\
===== ENDPOINT SEGUNDA VIA DE CONTA PARA EMAIL=====
\\
[[http://ENDPOINTALVO:PORTA/gsan/segundaViaContaRelatorio?matricula=IDDOIMOVEL&idConta=%5B%IDDACONTA%22,%20%&email=%22teste%40teste.consensocte.com.br%22|http://ENDPOINTALVO:PORTA/gsan/segundaViaContaRelatorio?matricula=IDDOIMOVEL&idConta=%5B%IDDACONTA%22,%20%&email=%22teste%40teste.consensocte.com.br%22]]
\\
===== Retorno em Caso de Sucesso =====
\\


===== Exemplo: =====
\\
{{  :integracoes:exe03.png?nolink&  }}




\\
 ===== Possíveis Códigos de Retorno =====

\\
|Código|Mensagem|
|400|"parâmetros inválidos"|
|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.