Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

 

Documentação de API

Descrição

 

Nome Físico

fchcrm/fchcrm1043api.p

Include com Parâmetros

fchcrm/fchcrm1043.i

Release Inicial

12.1.8

Versão de Integração

N/A

Data Liberação

N/A

Banco

Mdtcrm

Tabela

crm_depto

Aplicativo

Portal CRM

 

Evolução

Versão

12.1.8

Programa

fchcrm/fchcrm1043api.p

 

 

Objetivo

 

Realizar a manutenção de departamento.

 

 

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

ttDepartamento

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id  

Integer

 

Cod. identificador

Sim

nom_departamento         

character

 

Nome departamento

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:

findDepartment

Requisito

N/A

Sintaxe

findDepartment (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 DSCRMDepartamento, 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 DSCRMDepartamento

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

 

 

getAllDepartments

 

Requisito

N/A

 

Sintaxe

getAllDepartments (INPUT l_valid, OUTPUT TABLE ttDepartamento, OUTPUT TABLE RowErrors)

 

Descrição

Retorna todos os departamentos.

 

Parâmetros

Descrição

 

l_valid

Somente válidos

 

TABLE ttDepartamento

Tabela Departamento

 

TABLE RowErrors

Tabela de erros

 

Retorno

A API/BO irá retornar todos os departamentos, válidos ou não, conforme parâmetro. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

 

getDepartment

 

Requisito

N/A

 

Sintaxe

getDepartment (INPUT i_id, OUTPUT DATASET DSCRMDepartamento, OUTPUT TABLE RowErrors)

 

Descrição

Retorna o detalhe do departamento solicitado.

 

Parâmetros

Descrição

 

i_id

Codigo Identificador Sequencial

 

DATASET DSCRMDepartamento

Dataset com os registros selecionados

 

TABLE RowErrors

Tabela de erros

 

Retorno

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