Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

 

Documentação de API

Dados do Documento

Nome

API Fachada Tipo Cliente

Descrição

 

Nome Físico

fchcrm/fchcrm1018api.p

Include com Parâmetros

fchcrm/fchcrm1018.i

Release Inicial

12.1.8

Versão de Integração

N/A

Data Liberação

N/A

Banco

Mdtcrm

Tabela

crm_tip_clien

Aplicativo

Portal CRM

 

Evolução

Versão

12.1.8

Programa

fchcrm/fchcrm1018api.p

 

 

Objetivo

 

Realizar a manutenção de tipo cliente.

 

 

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

ttTipoCliente

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id  

integer

 

Cod. identificador

Sim

nom_tip_clien

character

 

Nome tipo cliente

Sim

idi_tip_cta

integer

 

Tipo conta

Sim

log_suspenso

logical

 

Suspenso

Sim

log_integrad_erp

logical

 

Integrado ERP

Sim

log_validac_cnpj_cpf

logical

 

Valida CNPJ/CPF

Sim

log_livre_1

logical

 

Lógico livre 1

Sim

 

Metodo Básico

 

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

findClientType

Requisito

N/A

Sintaxe

findClientType (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 DSCRMTipoCliente, 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 DSCRMTipoCliente

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

 

 

getAllClientTypes

 

Requisito

N/A

 

Sintaxe

getAllClientTypes (INPUT i_tipo_conta, OUTPUT TABLE ttTipoCliente, OUTPUT TABLE RowErrors)

 

Descrição

Retorna todos os tipos de cliente.

 

Parâmetros

Descrição

 

i_tipo_conta

Tipo

 

TABLE ttTipoCliente

Tabela tipo cliente

 

TABLE RowErrors

Tabela de erros

 

Retorno

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