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

De CIGAM WIKI
Sem resumo de edição
Linha 97: Linha 97:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sucesso.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sucesso.</p>


==== ListarId ====
== ListarId ==
<p align="justify"><i>
<p align=“justify”><i>
Método que tem por finalidade retornar os códigos da requisições cadastradas no ERP CIGAM.</br></i></p>
Método que tem por finalidade retornar os códigos da requisições cadastradas no ERP CIGAM.
 
</i></p>
*<b>Parâmetros:</b></br>
<div style="background-color: #f2f2f2">
&nbsp;&nbsp;&nbsp;<b>pin:</b><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: String 20<br>
  </div>
</br>
 
*<b>Exemplo de Retorno:</b></br>
**codigoRequisicao:


*<b>Parâmetros:</b><br>
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20
}}
<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/>
{{#tree: minExpandLevel=2 |
*codigoRequisicao
** Tipo: String 8
}}
<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 ==
<p align="justify"><i>
<p align="justify"><i>
Método que tem por finalidade retornar através do código da requisição as informações dela cadastrada no ERP CIGAM.</br></i></p>
Método que tem por finalidade retornar através do código da requisição as informações dela cadastrada no ERP CIGAM.
</i></p>
 
*<b>Parâmetros:</b><br>
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20


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


&nbsp;&nbsp;&nbsp;<b>codigoRequisicao:</b><br>
*codigoUnidadeNegocio
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tipo: Numérico 8<br>
** Tipo: String 3


  </div>
*codigoTipoOperacao
</br>
** Tipo: String 6
*<b>Exemplo de Retorno:</b></br>
 
**codigoRequisicao
*localEntrega
**codigoUnidadeNegocio
** Tipo: String 40
**codigoTipoOperacao
 
**localEntrega
*planoCompras
**planoCompras
** Tipo: String 10
**codigoCliente
 
**condicaoPagamento
*codigoCliente
**controle
** Tipo: String 6
**conta
 
**setor
*condicaoPagamento
**usrSoli1
** Tipo: String 60
**usrSoli3
 
*controle
** Tipo: String 2
 
*conta
** Tipo: String 6
 
*setor
** Tipo: String 6
 
*usrSoli1
** Tipo: String 20
 
*usrSoli3
** Tipo: Float 11.2
}}
<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>


==== 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.
</i></p>
 
*<b>Parâmetros:</b><br>
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20


*<b>Parâmetros:</b></br>
*dataInicial
<div style="background-color: #f2f2f2">
** Tipo: Date
&nbsp;&nbsp;&nbsp;<b>pin:</b><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: String 20<br>


&nbsp;&nbsp;&nbsp;<b>dataInicial</b><br>
*horaInicial
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: Date<br>
** Tipo: Time 6


&nbsp;&nbsp;&nbsp;<b>horaInicial</b><br>
*dataFinal
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: Time<br>
** Tipo: Date


&nbsp;&nbsp;&nbsp;<b>dataFinal</b><br>
*horaFinal
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: date<br>
** Tipo: Time 6
}}
<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/>
{{#tree: minExpandLevel=2 |
*codigoRequisicao
** Tipo: String 6


&nbsp;&nbsp;&nbsp;<b>horaFinal</b><br>
*codigoUnidadeNegocio
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: Time<br>
** Tipo: String 3


  </div>
*codigoTipoOperacao
</br>
** Tipo: String 6
*<b>Exemplo de Retorno:</b></br>
**codigoRequisicao
**codigoUnidadeNegocio
**codigoTipoOperacao
**localEntrega
**planoCompras
**codigoCliente
**condicaoPagamento
**controle
**conta
**setor
**usrSoli1
**usrSoli3


*localEntrega
** Tipo: String 40


*planoCompras
** Tipo: String 10
*codigoCliente
** Tipo: String 6
*condicaoPagamento
** Tipo: String 60
*codigoUsuarioCriacao
** Tipo: String 3
*dataCriacao
** Tipo: Date
*codigoUsuarioModificacao
** Tipo: String 3
*dataModificacao
** Tipo: Date
*controle
** Tipo: String 2
*conta
** Tipo: String 6
*setor
** Tipo: String 6
*usrSoli1
** Tipo: String 20
*usrSoli3
** Tipo: Float 11.2
}}
<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>


==== 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.
</i>
</i></p>
</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
<br>
&nbsp;&nbsp;&nbsp;<b>acao</b><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: String 1<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;C=Cadastrar, E=Excluir<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Se for informado algo diferente de C ou E não será aplicado nenhum filtro.<br>
<br>
&nbsp;&nbsp;&nbsp;<b>statusRegistro</b><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: String 1<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;L=Liberado, P=Pendente<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Se for informado algo diferente de P ou L não será aplicado nenhum filtro.<br>
<br>
  </div>
</br>


*<b>Exemplo de Retorno:</b></br>
*acao
**idRegistro
** Tipo: String 1
**acao
** C=Cadastrar, E=Excluir
**statusRegistro
** Se for informado algo diferente de C ou E não será aplicado nenhum filtro
**dataRequisicao
**horaRequisicao
**idCorrelato


*statusRegistro
** Tipo: String 1
** L=Liberado,P=Pendente
** Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
}}
<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/>
{{#tree: minExpandLevel=2 |
*idRegistro
** Tipo: Int 14


*acao
** Tipo: String 1
*statusRegistro
** Tipo: String 1
*dataRequisicao
** Tipo: Date
*horaRequisicao
** Tipo: Int 8
*idCorrelato
** Tipo: Int 14
}}
<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/>
Linha 240: Linha 310:
&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.<br/></p>
==== Excluir ====

Edição das 14h22min 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.

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:


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.

   Se sucesso:
      Sucesso.

ListarId

Método que tem por finalidade retornar os códigos da requisições 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 da requisição as informações dela cadastrada 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.

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:


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

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:


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.