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

De CIGAM WIKI
Sem resumo de edição
Sem resumo de edição
Linha 4: Linha 4:
***<b>Tipo de registro:</b> REQMAT
***<b>Tipo de registro:</b> REQMAT


== Cadastrar ==
<p align="justify"><i>
</i></p>
*<b>Parâmetros:</b><br>
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20
*statusRegistro
** Tipo: String 1
** L=Liberado, P=Pendente
** Este parâmetro não é obrigatório, mas se for informado algo diferente de L ou P, por padrão, será cadastrado como P na tabela de integração
*codigoUnidadeNegocio
** Tipo: String 3
*codigoTipoOperacao
** Obrigatório, Tipo: String 6
*localEntrega
** Tipo: String 40
*planoCompras
** Tipo: String 10
*codigoCliente
** Tipo: String 6
*condicaoPagamento
** Tipo: String 60
*controle
** Tipo: String 2
*conta
** Tipo: String 6
*setor
** Tipo: String 6
*usrSoli1
** Tipo: String 20
** Este é um campo de usuário e a condição para visibilidade na tela do seu programa correspondente será mediante configuração do mesmo no dicionário CIGAM.
*usrSoli3
** Tipo: Float 11.2
** Este é um campo de usuário e a condição para visibilidade na tela do seu programa correspondente será mediante configuração do mesmo no dicionário CIGAM.
}}
<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/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;idRegistro - ID que representa este registro na tabela de integração.<br/>
<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/>
<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>


==== ListarId ====
==== ListarId ====

Edição das 14h14min de 16 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 da requisições cadastradas no ERP CIGAM.

  • Parâmetros:

   pin:
      Obrigatório, Tipo: String 20


  • Exemplo de Retorno:
    • codigoRequisicao:


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 da requisição as informações dela cadastrada no ERP CIGAM.

  • Parâmetros:

   pin:
      Obrigatório, Tipo: String 20

   codigoRequisicao:
      Tipo: Numérico 8


  • Exemplo de Retorno:
    • codigoRequisicao
    • codigoUnidadeNegocio
    • codigoTipoOperacao
    • localEntrega
    • planoCompras
    • codigoCliente
    • condicaoPagamento
    • controle
    • conta
    • setor
    • usrSoli1
    • usrSoli3


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:
    • codigoRequisicao
    • codigoUnidadeNegocio
    • codigoTipoOperacao
    • localEntrega
    • planoCompras
    • codigoCliente
    • condicaoPagamento
    • controle
    • conta
    • setor
    • usrSoli1
    • usrSoli3



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



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.

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.

Cadastrar

Excluir