Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Dados do Documento

Nome

API Fachada Potencialidade

Descrição

 

Nome Físico

fchcrm/fchcrm1027api.p

Include com Parâmetros

fchcrm/fchcrm1027.i

Release Inicial

12.1.8

Versão de Integração

N/A

Data Liberação

N/A

Banco

Mdtcrm

Tabela

crm_potencd

Aplicativo

Portal CRM

 

Evolução

Versão

12.1.8

Programa

fchcrm/fchcrm1027api.p

 

 

Objetivo

 

Realizar a manutenção de potencialidade.

 

 

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

ttPotencialidade

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id  

integer

 

Cod. identificador

Sim

nom_potencd      

character

 

Nome potencialidade

Sim

log_suspenso

logical

 

Suspenso

Sim

 

Metodo Básico

 

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

findPotential

Requisito

N/A

Sintaxe

findPotential (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 DSCRMPotencialidade, 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 DSCRMPotencialidade

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

 

 

getAllPotentials

 

Requisito

N/A

 

Sintaxe

getAllPotentials (INPUT l_valid, INPUT i_group, INPUT i_subgroup, OUTPUT DATASET DSCRMPotencialidade, OUTPUT TABLE RowErrors)

 

Descrição

Retorna todas as potencialidades.

 

Parâmetros

Descrição

 

l_valid

Válido

 

i_group

Grupo

 

i_subgroup

Subgrupo

 

DATASET DSCRMPotencialidade

Dataset com os registros selecionados

 

TABLE RowErrors

Tabela de erros

 

Retorno

A API/BO irá retornar todas as potencialidades cadastradas. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.