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

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


==== Cadastrar ====
== Cadastrar ==
<p align="justify"><i>Método que tem por finalidade cadastrar a base de Empresa/Pessoas conforme os parâmetros e tipos indicados abaixo:</i></p>
<p align="justify"><i>Método que tem por finalidade cadastrar a base de Empresa/Pessoas conforme os parâmetros e tipos indicados abaixo:</i></p>


Linha 314: Linha 314:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parâmetro necessário não informado.<br/></p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parâmetro necessário não informado.<br/></p>


==== CadastrarEmpresas ====
== CadastrarEmpresas ==
<p align="justify"><i>
<p align="justify"><i>
Método que tem por finalidade cadastrar Empresa/Pessoas e contatos de empresas. Os
Método que tem por finalidade cadastrar Empresa/Pessoas e contatos de empresas. Os
Linha 759: Linha 759:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parâmetro necessário não informado.<br/></p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parâmetro necessário não informado.<br/></p>


==== ListarId ====
== ListarId ==
<p align="justify"><i>
<p align="justify"><i>
</i></p>
</i></p>
Linha 785: Linha 785:
</p>
</p>


==== ListarIndividual ====
== ListarIndividual ==
<p align="justify"><i>
<p align="justify"><i>
</i></p>
</i></p>
Linha 1 104: Linha 1 104:
</p>
</p>


==== ListarModificacoes ====
== ListarModificacoes ==
<p align="justify"><i>
<p align="justify"><i>
</i></p>
</i></p>
Linha 1 432: Linha 1 432:
</p>
</p>


==== ListarPendentes ====
== ListarPendentes ==
<p align="justify"><i>
<p align="justify"><i>
</i></p>
</i></p>
Linha 1 491: Linha 1 491:
&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>


==== LiberarPendentes ====
== LiberarPendentes ==
<p align="justify"><i>
<p align="justify"><i>
</i></p>
</i></p>
Linha 1 523: Linha 1 523:
</p>
</p>


==== ListarPorCnpjCpf  ====
== ListarPorCnpjCpf  ==
<p align="justify"><i>
<p align="justify"><i>
</i></p>
</i></p>
Linha 1 585: Linha 1 585:
&nbsp;&nbsp;&nbsp; Se listarEndereco for falso, então só ira listar empresa, nomeCompleto e fantasia.<br/></p>
&nbsp;&nbsp;&nbsp; Se listarEndereco for falso, então só ira listar empresa, nomeCompleto e fantasia.<br/></p>


==== ListarEmpresas  ====
== ListarEmpresas  ==
<p align="justify"><i>
<p align="justify"><i>
</i></p>
</i></p>
Linha 1 959: Linha 1 959:
&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>


==== ListarEmpresasCompleto ====
== ListarEmpresasCompleto ==
<p align="justify"><i>
<p align="justify"><i>
</i></p>
</i></p>
Linha 2 221: Linha 2 221:
&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>


==== ListarEmpresasPorRepresentante ====
== ListarEmpresasPorRepresentante ==
<p align="justify"><i>
<p align="justify"><i>
</i></p>
</i></p>
Linha 2 553: Linha 2 553:
&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>


==== ListarRepresentantesPorEmpresa ====
== ListarRepresentantesPorEmpresa ==
<p align="justify"><i>
<p align="justify"><i>
</i></p>
</i></p>
Linha 2 588: Linha 2 588:
&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>


==== ListarEmpresasPorCentralizadora ====
== ListarEmpresasPorCentralizadora ==
<p align="justify"><i>
<p align="justify"><i>
</i></p>
</i></p>
Linha 2 617: Linha 2 617:
&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 ====
== Excluir ==
<p align="justify"><i>
<p align="justify"><i>
</i></p>
</i></p>

Edição das 18h58min de 17 de fevereiro de 2022

Cadastrar

Método que tem por finalidade cadastrar a base de Empresa/Pessoas conforme os parâmetros e tipos indicados abaixo:

  • 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.

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

CadastrarEmpresas

Método que tem por finalidade cadastrar Empresa/Pessoas e contatos de empresas. Os dados da Empresa/Pessoas 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 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

  • 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.

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.

   Se sucesso:
      Sucesso.

ListarPorCnpjCpf

  • 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.

    Se listarEndereco for falso, então só ira listar empresa, nomeCompleto e fantasia.

ListarEmpresas

  • 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.

ListarEmpresasCompleto

  • 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.

ListarEmpresasPorRepresentante

  • 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.

ListarRepresentantesPorEmpresa

  • 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.

ListarEmpresasPorCentralizadora

  • 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.