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

De CIGAM WIKI
← Edição anteriorEdição posterior →
Elizama.Dias (discussão | contribs)
Administradores da interface, Administradores
2 798 edições
Linha 2 632: Linha 2 632:
&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.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}
== ListarTransportadoras ==
<p align="justify">
* <b>Coleção: EMTR - Transportadoras</b><br>
**Na coleção ‘EMTR’ são informados os códigos de empresa e/ou divisão de empresas a serem considerados para a listagem, juntamente com a faixa de data informada na chamada ao método.<br>
<br>
*<b>Parâmetros:</b></br>
{{#tree: minExpandLevel=2 |
*pin
**Obrigatório, Tipo: String 20
*dtInicial
**Obrigatório, Tipo: Date
*dtFinal
**Obrigatório, Tipo: Date
}}<br>
*<b>Retorno:</b><br>
{{#tree: minExpandLevel=2 |
*<geempres>
**<col>
***<codigoEmpresa db_column="Cd_empresa">c1</codigoEmpresa>
***<nomeCompleto db_column="Nome_completo">c2</nomeCompleto>
***<fantasia db_column="fantasia">c3</fantasia>
***<cnpjCpf db_column="Cnpj_cpf">c4</cnpjCpf>
***<inscricao db_column="inscricao">c5</inscricao>
***<cep db_column="cep">c6</cep>
***<endereco db_column="endereco">c7</endereco>
***<numero db_column="numero">c8</numero>
***<complemento db_column="complemento">c9</complemento>
***<municipio db_column="municipio">c10</municipio>
***<bairro db_column="bairro">c11</bairro>
***<uf db_column="uf">c12</uf>
***<codigoPais db_column="Cd_pais">c13</codigoPais>
***<codigoDivisao db_column="divisao">c14</codigoDivisao>
***<pessoa db_column="pessoa">c15</pessoa>
**</col>
*</geempres>
}}
{{VoltarInicio}}
{{VoltarInicio}}


Edição das 13h46min de 30 de novembro de 2022

Voltar
Integrador > WebServices > IN CadastroEmpresas.integrador

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.

Voltar ao início

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.
Ao passar um código de uma empresa já cadastrada é possível alterar seus dados.

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

Voltar ao início

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.

Voltar ao início

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.

Voltar ao início

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.

Voltar ao início

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.

Voltar ao início

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.

Voltar ao início

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.

Voltar ao início

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.

Voltar ao início

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.

Voltar ao início

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.

Voltar ao início

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.

Voltar ao início

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.

Voltar ao início

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.

Voltar ao início

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