Árvore de páginas

Documento de Fachada

Produto:

Datasul

Ocorrência:

Documentação de Fachada

Dados do Documento

Nome

Fachada Portador

Descrição

 

Nome Físico

fchcrm/fchcrm1040.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/fchcrm1040.p

 

 

Objetivo

 

Realizar a manutenção de portador.

 

 

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

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

 

Metodo Básico

 

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

REST_GET

Requisito

N/A

Sintaxe

REST_GET (INPUT  QP_start, INPUT QP_end, INPUT QP_properties, INPUT QP_values, INPUT QP_orderBy, INPUT QP_asc, INPUT QP_count, INPUT QP_type, OUTPUT REST_count, OUTPUT DATASET DSCRMPortador, OUTPUT TABLE RowErrors)

Descrição

Retorna os registros (query) conforme parâmetros informados.

Parâmetros

Descrição

QP_start

Valor inicial da faixa de registros

QP_end

Valor final da faixa de registros

QP_properties

Propriedades

QP_values

Valores

QP_orderBy

Campo para ordenação

QP_asc

Ascendente ou Decrescente

QP_count

Contador

QP_type

Tipo

REST_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.

 

 

Metodo Negócio

 

 

REST_GET_all

 

Requisito

N/A

 

Sintaxe

REST_GET_all (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.

 

REST_GET_detail

 

Requisito

N/A

 

Sintaxe

REST_GET_detail (INPUT PP_id, OUTPUT DATASET DSCRMPortador, OUTPUT TABLE RowErrors)

 

Descrição

Retorna o detalhe do portador solicitado.

 

Parâmetros

Descrição

 

PP_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.