Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

crmapi/apiCrmUnificCta.p

 

Considerações Gerais

 

Objetivo

Realizar a unificação das contas do CRM com base no gestão de planos

 

Funcionamento

A api possibilita tratamento e validação da regra de negócio. Na  forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.

 

A sintaxe para a chamada da API/BO é:

run crmapi/apiCrmUnificCta.p

 

A sintaxe para executar a API/BO em modo persistente é:

run crmapi/apiCrmUnificCta.p persistent set h-handle.

 

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

 

Método Negócio 

searchAccountUser

Requisito

-

Sintaxe

Run searchAccountUser in h-handle(output table ttContaE, output table RowErrors).

Descrição

Buscar as contas pendentes de unificação com base no usuário.

Parâmetros

Descrição

ttContaE

Conta ativa.

 

RowErrors

Erros.

Retorno

Retorna os as contas pendentes de unificação. Os  Erros serão tratados na  temp-table RowErrors.

searchAccount

Requisito

-

Sintaxe

Run searchAccount in h-handle(input cdtIni,

                              input cdtFim,

                              output table ttContaE,

                              output table RowErrors).

Descrição

Buscar as contas pendentes de unificação com base no filtro.

Parâmetros

Descrição

cdtIni

Data inicial.

 

cdtFim

Data fim.

 

ttContaE

Conta ativa.

 

RowErrors

Erros.

Retorno

Retorna os as contas pendentes de unificação com base no filtro. Os  Erros serão tratados na  temp-table RowErrors.

searchDeactive

Requisito

-

Sintaxe

Run searchDeactive in h-handle(input cdtIni, input cdtFim, output table ttContaE, output table RowErrors).

Descrição

Buscar as contas desativadas que estão pendentes de unificação, com base na conta a permanecer ativa.

Parâmetros

Descrição

ttContaE

Conta ativa.

 

ttContaD

Contas desativadas.

 

RowErrors

Erros.

Retorno

Retorna os as contas pendentes de unificação. Os  Erros serão tratados na  temp-table RowErrors.

searchEnder

Requisito

-

Sintaxe

Run searchEnder in h-handle(input table ttContaE,

                            input table ttContaD,

                            output table ttenderE,

                            output table ttenderD,

                            output table RowErrors).

Descrição

Buscar os enderços da conta ativa e desativa.

Parâmetros

Descrição

ttContaE

Conta ativa.

 

ttContaD

Contas desativadas.

 

ttenderE

Endereços da conta ativa.

 

ttenderD

Endereços da conta desativadas.

 

RowErrors

Erros.

Retorno

Retorna endereços das  contas. Os  Erros serão tratados na  temp-table RowErrors.

OpenQuery / SetConstraint / LinkTo 

setConstraintFaixaEquipamento

Requisito

Nenhum

Sintaxe

run setConstraintFaixaEquipamento in h-handle (input <integer>,

                                               input <integer>,

                                               input <character>,

                                               input <character>).

Descrição

Seta as restrições para abertura da query por equipamento

Parâmetros

Descrição

pCdnEmpresaIni

Código da Empresa Inicial.

pCdnEmpresaFim

Código da Empresa Final.

pCodEqptoIni

Código do Equipamento Inicial.

pCodEqptoFim

Código do Equipamento Final.

Retorno

 

xxxxxxxxxxxxxxxxxxxxxxx

Requisito

 

Sintaxe

 

Descrição

 

Parâmetros

Descrição

 

 

Retorno