IN CadastroContratos.integrador: mudanças entre as edições

De CIGAM WIKI
Sem resumo de edição
 
(3 revisões intermediárias pela mesma usuária não estão sendo mostradas)
Linha 1: Linha 1:
{{VoltarPagina}}
{{VoltarPagina}}
[[Integrador]] >
[[IN_CIGAM Integrador#Financeiro|WebServices]] >
[[IN CadastroContratos.integrador]]


*<b>Requisição</b>
=Requisição=
**<b>Soap:</b> http://servidor/CadastroContratos.integrador.asmx
*<b>Soap:</b> http://servidor/CadastroContratos.integrador.asmx
**<b>Rest/JSon:</b> http://servidor/CadastroContratos.integrador.ashx/metodo
*<b>Rest/JSon:</b> http://servidor/CadastroContratos.integrador.ashx/metodo
**<b>Tipo de registro:</b> <u>CCONTR</u></br>
**<b>Tipo de registro:</b> CCONTR</br>


== CadastrarContratos ==
=Métodos=
<p align=“justify”><i>Cadastra contratos, Parcela, Parcela Padrão, em uma única requisição. Os dados do Contrato deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.</i></p>
<!--bgcolor="#5F6B7A"-->
 
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
*<b>Parâmetros:</b><br>
    <tr>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>CadastrarContratos</b></font></td>
    </tr>
    <tr>
        <td><p style="margin: 0 0 6px 0; font-style: italic; line-height: 1.4;">Cadastra contratos, Parcela, Parcela Padrão, em uma única requisição. Os dados do Contrato deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.</p>
<p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 30: Linha 38:
}}
}}


*<b>Distribuição das Tags XML:</b><br>
<br><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Distribuição das Tags XML:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*<cadastroContrato>
*<cadastroContrato>
Linha 120: Linha 128:
}}
}}


*<b>Distribuição das Tags Json:</b><br>
<br><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Distribuição das Tags Json:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*{
*{
Linha 205: Linha 213:
}}
}}


<b>Retorno:</b><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Exemplo de retorno SOAP:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Exemplo de retorno SOAP:<br/>
{{#tree: minExpandLevel=2 |
*<retorno>
*<retorno>
***<mensagem>sucesso</mensagem>
**<mensagem>sucesso</mensagem>
****<detalhes>
***<detalhes>
*****<registro>
****<registro>
******<id>1149</id>
*****<id>1149</id>
*****</registro>
****</registro>
****</detalhes>
***</detalhes>
*</retorno>
*</retorno>
<br>
}}
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Exemplo de retorno REST:<br/>
 
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Exemplo de retorno REST:<br/>
{{#tree: minExpandLevel=2 |
*{
*{
**"mensagem": "sucesso",
**"mensagem": "sucesso",
Linha 233: Linha 246:
&nbsp;&nbsp;&nbsp;Se algum parâmetro inválido:<br/>
&nbsp;&nbsp;&nbsp;Se algum parâmetro inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parâmetro necessário não informado.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parâmetro necessário não informado.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


== LiberarPendentes ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align=“justify”><i>
    <tr>
</i></p>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>LiberarPendentes</b></font></td>
 
    </tr>
*<b>Parâmetros:</b><br>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 247: Linha 264:
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
Linha 256: Linha 273:
&nbsp;&nbsp;&nbsp;Se ID inválido ou não encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se ID inválido ou não encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Falha ao liberar registro.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Falha ao liberar registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


== ListarId ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align=“justify”><i>
    <tr>
</i></p>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarId</b></font></td>
 
    </tr>
*<b>Parâmetros:</b><br>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 267: Linha 288:
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
Linha 279: Linha 300:
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


== ListarIndividual ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align=“justify”><i>
    <tr>
</i></p>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarIndividual</b></font></td>
 
    </tr>
*<b>Parâmetros:</b><br>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 293: Linha 318:
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
Linha 533: Linha 558:
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


== ListarContratosCompleto ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align=“justify”><i>
    <tr>
</i></p>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarContratosCompleto</b></font></td>
 
    </tr>
*<b>Parâmetros:</b><br>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 553: Linha 582:
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
Linha 1 159: Linha 1 188:
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


== ListarModificacoes ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align=“justify”><i>
    <tr>
</i></p>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarModificacoes</b></font></td>
 
    </tr>
*<b>Parâmetros:</b><br>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 1 182: Linha 1 215:
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
Linha 1 422: Linha 1 455:
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


== ListarPendentes ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align=“justify”><i>
    <tr>
</i></p>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarPendentes</b></font></td>
 
    </tr>
*<b>Parâmetros:</b><br>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 1 443: Linha 1 480:
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
Linha 1 467: Linha 1 504:
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>

Edição atual tal como às 13h52min de 7 de outubro de 2026

Voltar
Integrador > WebServices > IN CadastroContratos.integrador

Requisição

Métodos

CadastrarContratos

Cadastra contratos, Parcela, Parcela Padrão, em uma única requisição. Os dados do Contrato deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.

Parâmetros:



Distribuição das Tags XML:



Distribuição das Tags Json:



Retornos:
   Se sucesso:
      * Exemplo de retorno SOAP:


      * Exemplo de retorno REST:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se algum parâmetro inválido:
      Parâmetro necessário não informado.

Voltar ao início

LiberarPendentes

Parâmetros:



Retornos:
   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se erro na conexão com banco de dados:
      A conexão com o banco de dados e/ou comando SQL possui erros.

   Se ID inválido ou não encontrado:
      Falha ao liberar registro.

Voltar ao início

ListarId

Parâmetros:



Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarIndividual

Parâmetros:



Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarContratosCompleto

Parâmetros:



Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarModificacoes

Parâmetros:



Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarPendentes

Parâmetros:



Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início