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

De CIGAM WIKI
Sem resumo de edição
Sem resumo de edição
Linha 140: Linha 140:
}}
}}


==== ListarId ====
=== ListarId ===
<p align="justify"><i>
<p align="justify"><i>
Método que tem por finalidade retornar os códigos de pedidos e sequencia cadastradas no ERP CIGAM.</br></i></p>
Método que tem por finalidade retornar os códigos de pedidos e sequencia cadastradas no ERP CIGAM.</br></i></p>
Linha 163: Linha 163:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.<br/></p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.<br/></p>


==== ListarIndividual ====
=== ListarIndividual ===
<p align="justify"><i>
<p align="justify"><i>
Método que tem por finalidade retornar através do código do pedido e sequencia as informações cadastradas no ERP CIGAM.</br></i></p>
Método que tem por finalidade retornar através do código do pedido e sequencia as informações cadastradas no ERP CIGAM.</br></i></p>
Linha 321: Linha 321:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.<br/></p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.<br/></p>


==== ListarModificacoes ====
=== ListarModificacoes ===
<p align="justify"><i>
<p align="justify"><i>
Método que tem por finalidade retornar através de uma faixa de datas as requisições modificadas nessa faixa no ERP CIGAM.</br></i></p>
Método que tem por finalidade retornar através de uma faixa de datas as requisições modificadas nessa faixa no ERP CIGAM.</br></i></p>
Linha 345: Linha 345:
</br>
</br>
*<b>Exemplo de Retorno:</b></br>
*<b>Exemplo de Retorno:</b></br>




Linha 358: Linha 357:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.<br/></p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.<br/></p>


==== ListarPendentes ====
=== ListarPendentes ===
<p align="justify"><i>
<p align="justify"><i>
Método que tem por finalidade retornar o ID dos registros que contenham a ação de Cadastrar ou Excluir e tenham o status de Liberado para Integração ou Pendente para Integração, conforme for indicado nos parâmetros.
Método que tem por finalidade retornar o ID dos registros que contenham a ação de Cadastrar ou Excluir e tenham o status de Liberado para Integração ou Pendente para Integração, conforme for indicado nos parâmetros.
Linha 386: Linha 385:




==== LiberarPendentes ====
=== LiberarPendentes ===
<p align="justify"><i>
<p align="justify"><i>
Método que tem por finalidade liberar registros que contenham o status 'P' (Pendente para Integração), conforme ID informado nos parâmetros.
Método que tem por finalidade liberar registros que contenham o status 'P' (Pendente para Integração), conforme ID informado nos parâmetros.
Linha 419: Linha 418:
</p>
</p>


==== Visualizar ====
=== Visualizar ===
==== Excluir ====
=== Excluir ===

Edição das 17h14min de 25 de fevereiro de 2021

Cadastrar

  • Distribuição das Tags XML:

ListarId

Método que tem por finalidade retornar os códigos de pedidos e sequencia cadastradas no ERP CIGAM.

  • Parâmetros:

   pin:
      Obrigatório, Tipo: String 20


  • Exemplo de Retorno:
      • codigoPedido:
      • sequencia:


Retornos:
   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

Método que tem por finalidade retornar através do código do pedido e sequencia as informações cadastradas no ERP CIGAM.

  • Parâmetros:

   pin:
      Obrigatório, Tipo: String 20

   codigoPedido:
      Tipo: String 12

   sequencia:
      Tipo: int 5


  • Exemplo de Retorno:


Retornos:
   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

Método que tem por finalidade retornar através de uma faixa de datas as requisições modificadas nessa faixa no ERP CIGAM.

  • Parâmetros:

   pin:
      Obrigatório, Tipo: String 20

   dataInicial
      Obrigatório, Tipo: Date

   horaInicial
      Obrigatório, Tipo: Time

   dataFinal
      Obrigatório, Tipo: date

   horaFinal
      Obrigatório, Tipo: Time


  • Exemplo de Retorno:




Retornos:
   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

Método que tem por finalidade retornar o ID dos registros que contenham a ação de Cadastrar ou Excluir e tenham o status de Liberado para Integração ou Pendente para Integração, conforme for indicado nos parâmetros.

  • Parâmetros:

   pin:
      Obrigatório, Tipo: String 20

   acao
      Obrigatório, Tipo: String 1
      C=Cadastrar, E=Excluir
      Se for informado algo diferente de C ou E não será aplicado nenhum filtro.

   statusRegistro
      Obrigatório, Tipo: String 1
      L=Liberado, P=Pendente
      Se for informado algo diferente de P ou L não será aplicado nenhum filtro.


  • Exemplo de Retorno:


LiberarPendentes

Método que tem por finalidade liberar registros que contenham o status 'P' (Pendente para Integração), conforme ID informado nos parâmetros.

  • Parâmetros:

   pin:
      Obrigatório, Tipo: String 20

   id
      Obrigatório, Tipo: int

   liberarCorrelatos
      Tipo: bool


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.

   Se Sucesso:
      Sucesso.

Visualizar

Excluir