IN CadastroContratos.integrador

De CIGAM WIKI
Revisão de 19h00min de 10 de fevereiro de 2022 por Camila.Oliveira (discussão | contribs) (CadastrarContratos)

Voltar

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:

Retorno:
   Se sucesso:
      Exemplo de retorno SOAP:

  • <retorno>
      • <mensagem>sucesso</mensagem>
        • <detalhes>
          • <registro>
            • <id>1149</id>
          • </registro>
        • </detalhes>
  • </retorno>


      Exemplo de retorno REST:

  • {
    • "mensagem": "sucesso",
    • "detalhes": [{
      • "registro": {
        • "id": "1149"
      • }
    • }]
  • }

}}


   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.

LiberarPendentes

  • Parâmetros:


Retorno:
   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.

ListarId

  • Parâmetros:


Retorno:
   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.

ListarIndividual

  • Parâmetros:


Retorno:
   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.

ListarContratosCompleto

  • Parâmetros:


Retorno:
   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.

ListarModificacoes

  • Parâmetros:


Retorno:
   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.

ListarPendentes

  • Parâmetros:


Retorno:
   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.