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

De CIGAM WIKI
← Edição anteriorEdição posterior →
Camila.Oliveira (discussão | contribs)
Administradores da interface, Administradores
5 242 edições
Sem resumo de edição
Sem resumo de edição
Linha 5: Linha 5:


== Cadastrar ==
== Cadastrar ==
*<b>Distribuição das Tags XML:</b>
*<b>Parâmetros:</b><br>
*<b>Parâmetros:</b><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
Linha 404: Linha 403:
== 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.
</i></p>


*<b>Parâmetros:</b></br>
*<b>Parâmetros:</b><br>
<div style="background-color: #f2f2f2">
{{#tree: minExpandLevel=2 |
&nbsp;&nbsp;&nbsp;<b>pin:</b><br>
*pin
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: String 20<br>
**Obrigatório, Tipo: String 20
  </div>
}}
</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>Exemplo de Retorno:</b></br>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
**codigoPedido:
{{#tree: minExpandLevel=2 |
**sequencia:
*codigoPedido
** Tipo: String 12


*sequencia
** Tipo: Int
}}
<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>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/>
<br/>
<br/>
&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.<br/></p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>


=== ListarIndividual ===
=== ListarIndividual ===

Edição das 13h39min de 17 de fevereiro de 2022

Cadastrar

  • Parâmetros:


Retorno:
   Se sucesso:
      idRegistro - ID que representa este registro na tabela de integração.

   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.

ListarId

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

  • 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

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:


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



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:
    • idRegistro
    • acao
    • statusRegistro
    • dataRequisicao
    • horaRequisicao
    • idCorrelato
    • codigoPedido
    • dataItem
    • codigoMaterial
    • situacao
    • codigoTipoOperacao

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

Método que tem por finalidade o retorno de dados do item do pedido indicado nos parâmetros.

  • Parâmetros:

   pin:
      Obrigatório, Tipo: String 20

   codigoPedido
      Obrigatório, Tipo: string 12

   sequencia
      Obrigatório, Tipo: int 5

Excluir

Método que tem por finalidade excluir o item conforme o código do pedido e sequencia indicados.

  • Parâmetros:

   pin:
      Obrigatório, Tipo: String 20

   codigoPedido:
      Tipo: String 12

   sequencia:
      Tipo: int 5



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 excluir registro.

   Se Sucesso:
      Sucesso.

Disponível em “https://www.cigam.com.br/wiki/index.php?title=IN_CadastroItensPedido.integrador&oldid=68046”