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

De CIGAM WIKI
Linha 433: Linha 433:
</i></p>
</i></p>


{{#tree: minExpandLevel=1 |
*<b>Parâmetros:</b><br>
*<b>Parâmetros:</b><br>
{{#tree: minExpandLevel=2 |
**pin
*pin
*** Obrigatório, Tipo: String 20
** 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/>
<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/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=1 |
*codigoPedido
*codigoPedido
** Tipo: String 20
** Tipo: String 20

Edição das 21h07min de 7 de dezembro de 2021

Cadastrar

Esse método é utilizado para o cadastro de pedido, podendo ser cadastradas suas dependências chamando outros serviços e métodos para que possa existir nele itens, títulos financeiros e outros.


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


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


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


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


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

LiberarPendentes

  • Parâmetros:


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.

ListarPedidos

  • Parâmetros:


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

ListarPedidosCompleto

Os dados do Pedidos serão listados em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.

  • Parâmetros:


Retornos:
   Se sucesso:

  • Parâmetros para o elemento pedido:
  • Parâmetros para o elemento tipoOperacao:
  • Parâmetros para o elemento unidadeNegocio:
  • Parâmetros para o elemento cliente:
  • Parâmetros para o elemento cobranca:
  • Parâmetros para o elemento representante:
  • Parâmetros para o elemento transportadora:
  • Parâmetros para o elemento consignatario:
  • Parâmetros para o elemento fornecedorEmpresa:
  • Parâmetros para o elemento despachanteEmpresa:
  • Parâmetros para o elemento regiaoMercado:
  • Parâmetros para o elemento contatoEmpresa:
  • Parâmetros para o elemento impostos:
  • Parâmetros para o elemento material:
  • Parâmetros para o elemento compradorFinal:
  • Parâmetros para o elemento unidadeNegocioTransf:
  • Parâmetros para o elemento centroArmazenagem:
  • Parâmetros para o elemento centroArmazenagemTransf:
  • Parâmetros para o elemento tabelaPreco:
  • Parâmetros para o elemento contaGerencial:
  • Parâmetros para o elemento controleItem:
  • Parâmetros para o elemento especif1:
  • Parâmetros para o elemento Lancamento:


  • Distribuição das Tags XML:


  • Distribuição das Tags Json:


   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.

ListarPedidosPorRepresentante

  • Parâmetros:


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

CadastrarPedidos

Cadastra pedidos, itens e grades em uma única requisição. Os dados do Pedido 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:


Retornos:
   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

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

   Se algum parâmetro inválido:
      Parâmetro necessário não informado.

VisualizarPedidoWeb

  • Parâmetros:


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

Excluir

  • Parâmetros:


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