Documento de API
Produto: | Datasul |
Ocorrência:
| Documentação de API |
Dados do Documento | |
Nome | API Fachada Faixa PRFV |
Descrição |
|
Nome Físico | fchcrm/fchcrm1048api.p |
Include com Parâmetros | fchcrm/fchcrm1048.i |
Release Inicial | 12.1.8 |
Versão de Integração | N/A |
Data Liberação | N/A |
Banco | Mdtcrm |
Tabela | crm_prfv_faixa |
Aplicativo | Portal CRM |
Evolução | |
Versão | 12.1.8 |
Programa | fchcrm/fchcrm1048api.p |
Objetivo
Realizar a manutenção de faixa de PRFV.
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 |
ttPrfvFaixa | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. Identificador | Sim |
val_freq | decimal |
| Valor frequência | Sim |
val_potenc | decimal |
| Valor potencia | Sim |
val_recenc | decimal |
| Valor recencia | Sim |
val_val | decimal |
| Valor valor | Sim |
val_recenc_freq_val | decimal |
| Valor RFV | Sim |
num_id_pessoa | integer |
| Numero Id pessoa | Sim |
dat_exec | date |
| Data execução | Sim |
num_id_prfv | integer |
| Numero Id PRFV | Sim |
des_prfv | character |
| Descrição prfv | Sim |
idi_calc_freq | integer |
| Frequência do calculo | Sim |
num_id_faixa_prfv | integer |
| Numero Id faixa PRFV | Sim |
des_faixa_prfv | character |
| Descrição faixa PRFV | Sim |
num_id_faixa | integer |
| Numero Id faixa | Sim |
des_faixa | character |
| Descrição faixa | Sim |
vli_inicial | decimal |
| Valor inicial | Sim |
vli_final | decimal |
| Valor final | Sim |
ttConta | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. Identificador | Sim |
nom_razao_social | character |
| Nome razão social | Sim |
cod_pessoa_erp | character |
| Código pessoa ERP | Sim |
nom_email_1 | character |
| Nome email 1 | Sim |
nom_email_2 | character |
| Nome email 2 | Sim |
log_acesso | logical |
| Possui acesso | Sim |
ttParamPrfv | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. Identificador | Sim |
idi_calc_freq | integer |
| Frequencia do calculo | Sim |
idi_fonte_prfv | integer |
| Fonte PRFV | Sim |
idi_tip_calc_prfv | integer |
| Tipo de calculo | Sim |
num_id_faixa | integer |
| Numero Id faixa | Sim |
des_faixa_prfv | character |
| Descrição faixa | Sim |
des_prfv | character |
| Descrição PRFV | Sim |
ttPrfvResumo | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. Identificador | Sim |
val_freq | decimal |
| Valor frequência | Sim |
val_potenc | decimal |
| Valor potencia | Sim |
val_recenc | decimal |
| Valor recencia | Sim |
val_val | decimal |
| Valor valor | Sim |
val_recenc_freq_val | decimal |
| Valor RFV | Sim |
num_id_pessoa | integer |
| Numero Id pessoa | Sim |
nom_razao_social | character |
| Nome razão social |
|
dat_exec | date |
| Data execução | Sim |
num_id_prfv | integer |
| Numero Id PRFV | Sim |
des_prfv | character |
| Descrição prfv | Sim |
idi_calc_freq | integer |
| Frequência do calculo | Sim |
idi_fonte_prfv | integer |
| Fonte PRFV | Sim |
idi_tip_calc_prfv | integer |
| Tipo de calculo | Sim |
num_id_faixa_prfv | integer |
| Numero Id faixa PRFV | Sim |
des_faixa_prfv | character |
| Descrição faixa PRFV | Sim |
num_id_faixa | integer |
| Numero Id faixa | Sim |
des_faixa | character |
| Descrição faixa | Sim |
vli_inicial | decimal |
| Valor inicial | Sim |
vli_final | decimal |
| Valor final | Sim |
Metodo Básico
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
findRangePrfv | ||
Requisito | N/A | |
Sintaxe | findRangePrfv (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 DSCRMPrfvFaixa, 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 DSCRMPrfvFaixa | 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. |
quickSearchCount | ||
Requisito | N/A | |
Sintaxe | quickSearchCount (INPUT c_where, INPUT c_value, OUTPUT i_count) | |
Descrição | Verifica faixa de PRFV que contenham o valor digitado na pesquisa rápida. | |
Parâmetros | Descrição | |
c_where | Condição | |
c_value | Valor | |
i_count | Contador | |
Retorno | A API/BO irá retornar a quantidade de registros que atendem a condição. |
Metodo Negócio
findRangePrfvBeforeRowFill |
| ||
Requisito | N/A |
| |
Sintaxe | findRangePrfvBeforeRowFill (INPUT DATASET DSCRMPrfvFaixa) |
| |
Descrição | Executa as instruções nele descritas antes do preenchimento da temp-table de faixa PRFV. |
| |
Parâmetros | Descrição |
| |
DATASET DSCRMPrfvFaixa | Dataset com os registros selecionados |
| |
Retorno | A API/BO irá executar este método, não enviando retorno. |
|
findRangePrfvAfterRowFill |
| ||
Requisito | N/A |
| |
Sintaxe | findRangePrfvAfterRowFill (INPUT DATASET DSCRMPrfvFaixa) |
| |
Descrição | Executa as instruções nele descritas após preenchimento da temp-table de faixa PRFV. |
| |
Parâmetros | Descrição |
| |
DATASET DSCRMPrfvFaixa | Dataset com os registros selecionados |
| |
Retorno | A API/BO irá executar este método, não enviando retorno. |
|
findPrfvAccountAfterRowFill |
| ||
Requisito | N/A |
| |
Sintaxe | findPrfvAccountAfterRowFill (INPUT DATASET DSCRMPrfvFaixa) |
| |
Descrição | Executa as instruções nele descritas após preenchimento da temp-table de conta. |
| |
Parâmetros | Descrição |
| |
DATASET DSCRMPrfvFaixa | Dataset com os registros selecionados |
| |
Retorno | A API/BO irá executar este método, não enviando retorno. |
|
getSummaryPrfv |
| ||
Requisito | N/A |
| |
Sintaxe | getSummaryPrfv (INPUT i_account, OUTPUT TABLE ttPrfvResumo, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna resumo do PRFV. |
| |
Parâmetros | Descrição |
| |
i_account | Codigo Identificador Sequencial |
| |
TABLE ttPrfvResumo | Tabela Resumo PRFV |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar o resumo do PRFV. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
|
getAllPrfvs |
| ||
Requisito | N/A |
| |
Sintaxe | getAllPrfvs (OUTPUT TABLE ttParamPrfv, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna os parâmetros do PRFV. |
| |
Parâmetros | Descrição |
| |
TABLE ttParamPrfv | Tabela Parametros PRFV |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar os parâmetros do PRFV. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
|