IN CadastroContratos.integrador: mudanças entre as edições
Sem resumo de edição |
|||
| (2 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]] | |||
=Requisição= | |||
*<b>Soap:</b> http://servidor/CadastroContratos.integrador.asmx | |||
*<b>Rest/JSon:</b> http://servidor/CadastroContratos.integrador.ashx/metodo | |||
**<b>Tipo de registro:</b | **<b>Tipo de registro:</b> CCONTR</br> | ||
== | =Métodos= | ||
< | <!--bgcolor="#5F6B7A"--> | ||
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%"> | |||
<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: | ||
}} | }} | ||
<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: | ||
}} | }} | ||
<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> | <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/> | |||
Se sucesso:<br/> | Se sucesso:<br/> | ||
Exemplo de retorno SOAP:<br/> | * Exemplo de retorno SOAP:<br/> | ||
{{#tree: minExpandLevel=2 | | |||
*<retorno> | *<retorno> | ||
**<mensagem>sucesso</mensagem> | **<mensagem>sucesso</mensagem> | ||
| Linha 216: | Linha 226: | ||
***</detalhes> | ***</detalhes> | ||
*</retorno> | *</retorno> | ||
<br> | }} | ||
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/> | |||
* Exemplo de retorno REST:<br/> | |||
{{#tree: minExpandLevel=2 | | |||
*{ | *{ | ||
**"mensagem": "sucesso", | **"mensagem": "sucesso", | ||
| Linha 233: | Linha 246: | ||
Se algum parâmetro inválido:<br/> | Se algum parâmetro inválido:<br/> | ||
Parâmetro necessário não informado.</p> | Parâmetro necessário não informado.</p> | ||
{{VoltarInicio}}</td> | |||
</tr> | |||
</table></center> | |||
== | <center><table class="mw-collapsible mw-collapsed wikitable" width="95%"> | ||
< | <tr> | ||
</ | <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>LiberarPendentes</b></font></td> | ||
</tr> | |||
<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> | <b>Retornos:</b><br/> | ||
Se pin inválido:<br/> | Se pin inválido:<br/> | ||
O usuário não possui direitos suficientes para executar esta rotina.<br/> | O usuário não possui direitos suficientes para executar esta rotina.<br/> | ||
| Linha 256: | Linha 273: | ||
Se ID inválido ou não encontrado:<br/> | Se ID inválido ou não encontrado:<br/> | ||
Falha ao liberar registro.</p> | Falha ao liberar registro.</p> | ||
{{VoltarInicio}}</td> | |||
</tr> | |||
</table></center> | |||
== | <center><table class="mw-collapsible mw-collapsed wikitable" width="95%"> | ||
< | <tr> | ||
</ | <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarId</b></font></td> | ||
</tr> | |||
<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> | <b>Retornos:</b><br/> | ||
Se sucesso:<br/> | Se sucesso:<br/> | ||
{{#tree: minExpandLevel=2 | | {{#tree: minExpandLevel=2 | | ||
| Linha 279: | Linha 300: | ||
Se nenhum registro encontrado:<br/> | Se nenhum registro encontrado:<br/> | ||
A consulta não retornou nenhum registro.</p> | A consulta não retornou nenhum registro.</p> | ||
{{VoltarInicio}}</td> | |||
</tr> | |||
</table></center> | |||
== | <center><table class="mw-collapsible mw-collapsed wikitable" width="95%"> | ||
< | <tr> | ||
</ | <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarIndividual</b></font></td> | ||
</tr> | |||
<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> | <b>Retornos:</b><br/> | ||
Se sucesso:<br/> | Se sucesso:<br/> | ||
{{#tree: minExpandLevel=2 | | {{#tree: minExpandLevel=2 | | ||
| Linha 533: | Linha 558: | ||
Se nenhum registro encontrado:<br/> | Se nenhum registro encontrado:<br/> | ||
A consulta não retornou nenhum registro.</p> | A consulta não retornou nenhum registro.</p> | ||
{{VoltarInicio}}</td> | |||
</tr> | |||
</table></center> | |||
== | <center><table class="mw-collapsible mw-collapsed wikitable" width="95%"> | ||
< | <tr> | ||
</ | <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarContratosCompleto</b></font></td> | ||
</tr> | |||
<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> | <b>Retornos:</b><br/> | ||
Se sucesso:<br/> | Se sucesso:<br/> | ||
{{#tree: minExpandLevel=2 | | {{#tree: minExpandLevel=2 | | ||
| Linha 1 159: | Linha 1 188: | ||
Se nenhum registro encontrado:<br/> | Se nenhum registro encontrado:<br/> | ||
A consulta não retornou nenhum registro.</p> | A consulta não retornou nenhum registro.</p> | ||
{{VoltarInicio}}</td> | |||
</tr> | |||
</table></center> | |||
== | <center><table class="mw-collapsible mw-collapsed wikitable" width="95%"> | ||
< | <tr> | ||
</ | <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarModificacoes</b></font></td> | ||
</tr> | |||
<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> | <b>Retornos:</b><br/> | ||
Se sucesso:<br/> | Se sucesso:<br/> | ||
{{#tree: minExpandLevel=2 | | {{#tree: minExpandLevel=2 | | ||
| Linha 1 422: | Linha 1 455: | ||
Se nenhum registro encontrado:<br/> | Se nenhum registro encontrado:<br/> | ||
A consulta não retornou nenhum registro.</p> | A consulta não retornou nenhum registro.</p> | ||
{{VoltarInicio}}</td> | |||
</tr> | |||
</table></center> | |||
== | <center><table class="mw-collapsible mw-collapsed wikitable" width="95%"> | ||
< | <tr> | ||
</ | <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarPendentes</b></font></td> | ||
</tr> | |||
<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> | <b>Retornos:</b><br/> | ||
Se sucesso:<br/> | Se sucesso:<br/> | ||
{{#tree: minExpandLevel=2 | | {{#tree: minExpandLevel=2 | | ||
| Linha 1 467: | Linha 1 504: | ||
Se nenhum registro encontrado:<br/> | Se nenhum registro encontrado:<br/> | ||
A consulta não retornou nenhum registro.</p> | 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
- Soap: http://servidor/CadastroContratos.integrador.asmx
- Rest/JSon: http://servidor/CadastroContratos.integrador.ashx/metodo
- Tipo de registro: CCONTR
- Tipo de registro: CCONTR
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:
|
| LiberarPendentes |
Parâmetros:
|
| ListarId |
Parâmetros:
|
| ListarIndividual |
Parâmetros:
|
| ListarContratosCompleto |
Parâmetros:
|
| ListarModificacoes |
Parâmetros:
|
| ListarPendentes |
Parâmetros:
|
