Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Dados do Documento | |
Nome | API Fachada Produtos |
Descrição |
|
Nome Físico | fchcrm/fchcrm1019api.p |
Include com Parâmetros | fchcrm/fchcrm1019.i |
Release Inicial | 12.1.8 |
Versão de Integração | N/A |
Data Liberação | N/A |
Banco | Mdtcrm |
Tabela | crm_produt |
Aplicativo | Portal CRM |
Evolução | |
Versão | 12.1.8 |
Programa | fchcrm/fchcrm1019api.p |
Objetivo
Realizar a manutenção de produtos.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
ttFilter | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
c_table | character |
| Tabela | Sim |
c_property | character |
| Propriedade | Sim |
c_value | character |
| Valor | Sim |
ttProduto | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. Identificador | Sim |
nom_produt | character |
| Nome produto | Sim |
cod_item_erp | character |
| Código item ERP | Sim |
log_integrad_erp | Logical |
| Integrado com ERP | Sim |
num_id_umd_vda | integer |
| Código unidade venda | Sim |
nom_umd_vda | character |
| Nome unidade venda | Não |
val_preco_unit | decimal |
| Valor preço unitario | Sim |
ttReferencia | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. Identificador | Sim |
nom_refer | character |
| Nome referencia | Sim |
ttVersao | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | Integer |
| Cod. Identificador | Sim |
nom_vers_produt | Character |
| Nome versão produto | Sim |
ttComponente | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. Identificador | Sim |
nom_produt | character |
| Nome produto | Sim |
cod_item_erp | character |
| Código item ERP | Sim |
Metodo Básico
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
findProduct | ||
Requisito | N/A | |
Sintaxe | findProduct (INPUT i_start, INPUT i_end, INPUT c_properties, INPUT c_values, INPUT c_orderBy, INPUT c_asc, INPUT l_count, INPUT i_type, OUTPUT i_count, OUTPUT DATASET DSCRMProduto, OUTPUT TABLE RowErrors) | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
i_start | Valor inicial da faixa de registros | |
i_end | Valor final da faixa de registros | |
c_properties | Propriedades | |
c_values | Valores | |
c_orderBy | Campo para ordenação | |
c_asc | Ascendente ou Decrescente | |
l_count | Contador | |
i_type | Tipo | |
i_count | Quantidade de registros selecionados | |
DATASET DSCRMProduto | Dataset com os registros selecionados | |
TABLE RowErros | Tabela de erros | |
Retorno | A API/BO irá retornar os registros selecionados e a quantidade. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
Metodo Negócio
findProductAfterRowFill |
| ||
Requisito | N/A |
| |
Sintaxe | findProductAfterRowFill (INPUT DATASET DSCRMProduto) |
| |
Descrição | Executa as instruções nele descritas após preenchimento da temp-table de produto. |
| |
Parâmetros | Descrição |
| |
DATASET DSCRMProduto | Dataset com os registros selecionados |
| |
Retorno | A API/BO irá executar este método, não enviando retorno. |
|
findProductBeforeRowFill |
| ||
Requisito | N/A |
| |
Sintaxe | findProductBeforeRowFill (INPUT DATASET DSCRMProduto) |
| |
Descrição | Executa as instruções nele descritas antes do preenchimento da temp-table de produto. |
| |
Parâmetros | Descrição |
| |
DATASET DSCRMProduto | Dataset com os registros selecionados |
| |
Retorno | A API/BO irá executar este método, não enviando retorno. |
|
getAllProducts |
| ||
Requisito | N/A |
| |
Sintaxe | getAllProducts (INPUT i_priceTable, OUTPUT TABLE ttProduto, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna todos os produtos. |
| |
Parâmetros | Descrição |
| |
i_priceTable | Codigo Identificador Sequencial da Tabela de Preço |
| |
TABLE ttProduto | Tabela Produto |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar todos os produtos cadastrados para a tabela de preço selecionada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
|
getReferences |
| ||
Requisito | N/A |
| |
Sintaxe | getReferences (INPUT i_classif, OUTPUT TABLE ttReferencia, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna as referencias. |
| |
Parâmetros | Descrição |
| |
i_classif | Código Identificador Sequencial |
| |
TABLE ttReferencia | Tabela Referencia |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar as referencias solicitadas. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
|
getVersions |
| ||
Requisito | N/A |
| |
Sintaxe | getVersions (INPUT i_classif, OUTPUT TABLE ttVersao, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna as versões. |
| |
Parâmetros | Descrição |
| |
i_classif | Código Identificador Sequencial |
| |
TABLE ttVersao | Tabela Versao |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar as versões solicitadas. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
|
getComponents |
| ||
Requisito | N/A |
| |
Sintaxe | getComponents (INPUT i_classif, OUTPUT TABLE ttComponente, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna os componentes. |
| |
Parâmetros | Descrição |
| |
i_classif | Código Identificador Sequencial |
| |
TABLE ttComponente | Tabela Componente |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar os componentes solicitados. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
|