Documento de API
Produto: | Datasul |
Ocorrência:
| Documentação de API |
Dados do Documento | |
Nome | API Fachada Referência |
Descrição |
|
Nome Físico | fchcrm/fchcrm1028api.p |
Include com Parâmetros | fchcrm/fchcrm1028.i |
Release Inicial | 12.1.8 |
Versão de Integração | N/A |
Data Liberação | N/A |
Banco | Mdtcrm |
Tabela | crm_refer |
Aplicativo | Portal CRM |
Evolução | |
Versão | 12.1.8 |
Programa | fchcrm/fchcrm1028api.p |
Objetivo
Realizar a manutenção de referência.
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 |
ttReferencia | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. Identificador | Sim |
nom_refer | character |
| Nome referência | Sim |
cod_refer_erp | character |
| Código referencia 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:
findReference | ||
Requisito | N/A | |
Sintaxe | findReference (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 DSCRMReferencia, 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 DSCRMReferencia | 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
getAllReferences |
| ||
Requisito | N/A |
| |
Sintaxe | getAllReferences (INPUT i_product, OUTPUT TABLE ttReferencia, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna todas as referencias do produto. |
| |
Parâmetros | Descrição |
| |
i_product | Codigo Identificador Sequencial |
| |
TABLE ttReferencia | Tabela Referência |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar todas as referencias do produto solicitado. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
|
getReferencesByPriceTableItem |
| ||
Requisito | N/A |
| |
Sintaxe | getReferencesByPriceTableItem (INPUT i_price_table_item, OUTPUT TABLE ttReferencia, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna todas as referencias do item da tabela de preço. |
| |
Parâmetros | Descrição |
| |
i_price_table_item | Codigo Identificador Sequencial |
| |
TABLE ttReferencia | Tabela Referência |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar todas as referencias do item da tabela de preço solicitado. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
|