Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | cdp/cdapi994.p |
Objetivo: Cadastrar empresas no produto EMS2.
Considerações Gerais:
- Deverá ser passada 1 (uma) temp-table de entrada e 1 (uma) temp-table de saída com informações e parâmetros para a criação de empresas.
- Podem ser criadas várias empresas de uma só vez.
- Os parâmetros são passados através do comando INPUT PARAM, com exceção da última temp-table, que deve ser passado com OUTPUT PARAM. Exemplo:
run cdp/cdapi994.p (Input table tt-empresa,
output table tt-erros).
- A API funciona da seguinte forma: Recebe como parâmetros as temp-tables, faz as criticas das mesmas, caso não tenha ocorrido nenhum problema faz a(s) atualização(ões) da(s) empresa(s).
- As definições das temp-tables devem seguir exatamente as descrições contidas neste documento, para que não ocorram conflitos na chamada da api.
Parâmetros de Entrada
Temp-table tt-empresa: deverão ser passadas as informações para criação da tabela empresa.
Nesta temp-table também é passado a versão de integração, através do campo tt-empresa.cod-versao-integ.
TEMP-TABLE TT-DOC-I-AP | ||||
Atributo | Tipo | Formato | Valor Inicial | Obrigatório |
ep-codigo | integer | “>>9” | 0 | Sim |
Nome | Character | X(70) |
| Sim |
Razao-social | Character | X(40) |
| Sim |
Endereço | Character | X(35) |
| Sim |
CEP | Character | X(12) |
| Sim |
Cidade | Character | X(25) |
| Sim |
UF | Character | X(4) |
| Sim |
cgc | Character | X(19) |
| Sim |
Inscr-estad | Character | X(19) |
| Sim |
Character | X(40) |
| Sim | |
Home-page | Character | X(40) |
| Sim |
Bairro | Character | X(30) |
| Sim |
Pais | Character | X(20) |
| Sim |
Log-2 | Logical | “Sim/Não” | NO | Sim |
Telefone[1] | Character | X(15) |
| Sim |
Telefone[2] | Character | X(15) |
| Sim |
Cod-versao-integ | Integer | “999” |
| Sim |
Atributo | Descrição |
Ep-codigo | Código da empresa, a empresa do lote deve ser a empresa do usuário. |
Nome | Nome da empresa |
Razao-social | Razão Social |
Endereço | Endereço |
CEP | CEP |
Cidade | Cidade |
UF | Unidade de Federação |
cgc | CGC |
Inscr-estad | Inscrição Estadual |
Home-page | Home Page |
Bairro | Bairro |
Pais | País |
Log-2 | Agente Retenção de Iva |
Telefone[1] | Telefone – 1 |
Telefone[2] | Telefone – 2 |
Cod-versao-integ | Deve ser passado através deste campo, a versão de integração da API. |
Parâmetros de Saída
Temp-table tt-erros: Para cada empresa que deseja ser criada, irá executar uma procedure interna que fará a consistência dos itens, no retorno a API verifica se houve um registro na temp-table tt-erros, se encontrar é porque a empresa não foi criada, fica a cargo do programa chamador identificar os erros que houveram na consistência.
TEMP-TABLE TT-erros | |||
Atributo | Tipo | Formato | Valor Inicial |
Cod-erro | Character | “x(10)” |
|
Desc-erro | Character | “x(60)” view-as editor max-chars 2000 scrollbar-verticarl size 50 by 4 |
|
Atributo | Descrição |
Cod-erro | Código do erro. Guarda o número da mensagem de erro. |
Desc-erro | Descrição do erro. |
Execução:
- O programa cdp/cd994.p irá executar uma validação básica:
Validação: Versão de Integração
O programa irá verificar se o programa chamador está íntegro com a API, e isto ocorre através da verificação da versão de integração passada como parâmetro através da temp-table tt-empresa (campo cod-versao-integ). Caso a versão esteja incompatível, a API abortará a execução retornando através da temp-table tt-erros o código de erro 3941.
Número do Erro | Mensagem | Ajuda |
3941 | Versão de Integração incorreta. | A versão de integração é informada através de parâmetros internos e o que foi informado está incompatível. Favor contatar suporte técnico. |
Caso ocorra um algum erro de validação, a empresa não será criada.
Cabe ao programa de origem, verificar os erros.
