Produto:

Datasul

Ocorrência:

Documentação de API

Dados do Documento

Nome

API Fachada Portador

Descrição

Nome Físico

fchcrm/fchcrm1040api.p

Include com Parâmetros

fchcrm/fchcrm1040.i

Release Inicial

12.1.8

Versão de Integração

N/A

Data Liberação

N/A

Banco

Mdtcrm

Tabela

crm_erp_portad

Aplicativo

Portal CRM

Evolução

Versão

12.1.8

Programa

fchcrm/fchcrm1040api.p

ttFilter

Atributo

Tipo

Formato

Descrição

Obrigatório

c_table  

character

Tabela

Sim

c_property            

character

Propriedade

Sim

c_value         

character

Valor    

Sim

ttPortador

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id  

integer

Cod. identificador

Sim

cod_portad_erp      

character

Código portador ERP

Sim

nom_portador

character

Nome portador

Sim

cod_estab

character

Código estabelecimento

Sim

idi_modalid_portad

integer

Modalidade portador

Sim

log_integrad_erp

logical

Integrado ERP

Sim

findBearer

Requisito

N/A

Sintaxe

findBearer (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 DSCRMPortador, 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 DSCRMPortador

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.

getAllBearers

Requisito

N/A

Sintaxe

getAllBearers (OUTPUT TABLE ttPortador, OUTPUT TABLE RowErrors)

Descrição

Retorna todos os portadores.

Parâmetros

Descrição

TABLE ttPortador

Tabela Portador

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar todos os portadores cadastrados. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getBearer

Requisito

N/A

Sintaxe

getBearer (INPUT i_id, OUTPUT DATASET DSCRMPortador, OUTPUT TABLE RowErrors)

Descrição

Retorna o detalhe do portador solicitado.

Parâmetros

Descrição

i_id

Codigo Identificador Sequencial

DATASET DSCRMPortador

Dataset com os registros selecionados

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar o detalhe do portador solicitado. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.