Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	crmapi\apiCrmRegistroAcao.p

Objetivo

Verificações que envolvem a tela de Registro de Ação.

Tabelas Temporárias

Atributos das tabelas temporárias de entrada e saída:

ttCrmHistorAcao
Atributo	Tipo	Formato	Descrição	Obr.
num_id_template	Char
log_salva_template	Char
num_id_pessoa	Char
num_id_contat	Char
num_id_campanha	Char
num_id_acao	Char
num_id_resultado	Char
num_id_detmnto	Char
num_id_mid	Char
lancar_despesas	Log
dat_inic	Char
dat_fim	Char
hra_inic	Char
hra_fim	Char
dsl_descricao	Char
dsl_procedimentos	Char
num_id_oportun	Char
num_id_ocor	Char
num_id_tar	Char
num_id_usuar_cad	Char
dat_cadastro	Char
dat_exec	Char
hra_cadastro	Char
hra_exec	Char

tt-crm_vinc
Atributo	Tipo	Formato	Descrição	Obr.
num_id	Int

tt-campanha
Atributo	Tipo	Formato	Descrição	Obr.
num_id	Int

tt-crm_campanha_acao
Atributo	Tipo	Formato	Descrição	Obr.
num_id_acao	Int

tt-crm_acao_mid
Atributo	Tipo	Formato	Descrição	Obr.
num_id_midia	Int

tt-crm_acao_restdo
Atributo	Tipo	Formato	Descrição	Obr.
num_id_restdo	Int

tt-crm_restdo_detmnto
Atributo	Tipo	Formato	Descrição	Obr.
num_id_detmnto	Int

tt-tarefa
Atributo	Tipo	Formato	Descrição	Obr.
numid	Int
conta	Int
campanha	Int
contato	Int
acao	Int

tt-crm_tip_despes
Atributo	Tipo	Formato	Descrição	Obr.
num_id	Int

Métodos

Métodos básicos

Método: createRegistroAcao.

Descrição: Cria o registro de ação.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
ttCrmHistorAcao	tt		X
l-qualificar	Log		X
i-numIdRetorno	Int			X

Método: retornaDadosLead.

Descrição: Retorna os valores de Lead que estão nos parâmetros do CRM.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
c-numIdCampanha	Char			X
c-numIdAcao	Char			X
c-numIdResultado	Char			X
c-numIdMidia	Char			X

Método: geraContatosConta.

Descrição: Retorna os contatos da conta passada como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdPessoa	Char		X
tt-crm_vinc	tt			X
nenhumContato	Log			X
c-pontoFocal	Char			X

Método: geraCampanhasUsuarioLogado.

Descrição: Retorna as campanhas que o usuário logado tem acesso pela hierarquia.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
tt-campanha	tt			X
nenhumaCampanha	Log			X

Método: geraAcoesCampanha.

Descrição: Retorna as campanhas relacionadas com a ação passada como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdAcao	Char		X
tt-crm_campanha_acao	tt			X
nenhumaAcao	Log			X

Método: geraMidiasAcao.

Descrição: Retorna as mídias relacionadas com a campanha e com a ação passadas como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdCampanha	Char		X
numIdAcao	Char		X
tt-crm_acao_mid	tt			X
nenhumaMidia	Log			X

Método: geraResultadosAcao.

Descrição: Retorna os resultados relacionados com a campanha e com a ação passadas como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdCampanha	Char		X
numIdAcao	Char		X
tt-crm_acao_restdo	tt			X
nenhumResultado	Log			X

Método: geraDetalhamentosResultado.

Descrição: Retorna os detalhamentos relacionados com o resultado passado como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdRestdo	Char
tt-crm_restdo_detmnto	tt
nenhumDetalhamento	Log

Método: dataHora.

Descrição: Retorna data e hora atual.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
horaInicial	Char			X
dataInicial	Char			X
horaFinal	Char			X
dataFinal	Char			X

Método: returnUser.

Descrição: Retorna usuário logado.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
c-num_id_usuar	Char			X

Método: returnProced.

Descrição: Retorna o procedimento relacionado com o resultado passado como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdRestdo	Int		X
dslProcedimentos	Char			X

Método: contatoDefaultConta.

Descrição: Retorna o contato padrão da conta passada como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdPessoa	Char		X
numIdContato	Char			X

Método: contaDefaultConta.

Descrição: Retorna o ponto focal da conta passada como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
g-numIdPessoa	Int		X
numIdContato	Char			X

Método: verificaDataRetroativa.

Descrição: Verifica se a data e hora informada são válidas.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
data	Char		X
hora	Char		X
retroativaProibida	Log			X

Método: validaDataHora.

Descrição: Verifica se a data e hora informada são válidas.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
dataInicial	Char		X
horaInicial	Char		X
dataFinal	Char		X
horaFinal	Char		X
dataHoraProibida	Log			X
i-dataOuHora	Int			X

Método: allDefault.

Descrição: Retorna ação, resultado e mídia padrões da campanha passada como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdCampanha	Char		X
numIdAcao	Char			X
numIdRestdo	Char			X
numIdMid	Char			X

Método: restdoMidiaDefault.

Descrição: Retorna mídia e resultado padrão da campanha e ação passadas como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdCampanha	Char		X
numIdAcao	Char		X
numIdRestdo	Char			X
numIdMid	Char			X

Método: acaoDefault.

Descrição: Retorna ação padrão da campanha passada como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdCampanha	Char		X
numIdAcao	Char			X

Método: carregarDeAcordoComTarefa.

Descrição: Retorna os valores da Tarefa, mediante id da mesma passado como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-tarefa	Int		X
tt-tarefa	tt			X

Método: retornaCampanhaAcao.

Descrição: Retorna id da tabela de relacionamento de campanha X ação da campanha e ação passadas como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdCampanha	Char		X
numIdAcao	Char		X
numIdCampanhaAcao	Char			X

Método: retornaTipDespesCampanhaAcao.

Descrição: Retorna CRM_TIP_DESPES relacionados com a Campanha Ação passada como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdCampanhaAcao	Char		X
tt-crm_tip_despes	tt			X
nenhumTipDespes	Log			X

Método: retornaValoresTipDespes.

Descrição: Retorna os valores de CRM_ACAO_TIP_DESPES do id passado como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdTipDespes	Char		X
numIdCampanhaAcao	Char		X
c-numIdUnidMedida	Char			X
c-qtdItensDespesRealzdo	Char			X
c-valDespes	Char			X
c-dslTipDespes	Char			X
c-numIdCampanhaAcao	Char			X

Método: verificaHoraErrada.

Descrição: Verifica se a hora informada é válida.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
p-hora	Char		X
p-retorno	Char			X

Método: verificaExisteTipDespes.

Descrição: Verifica se existe tipo de despesa cadastrada para a Campanha e Ação passadas como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdCampanha	Char		X
numIdAcao	Char		X
nenhumTipDespes	Log			X

Método: findCampDefault.

Descrição: Retorna a campanha da oportunidade passada como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
c-oportun	Char		X
c-campDefault	Char			X

Método: canLaunchCosts.

Descrição: Retorna se há despesa cadastrada para Campanha e Ação passadas como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdCampanha	Char		X
numIdAcao	Char		X
nenhumDespes	Log			X

Método: retornaIdOcorrencia.

Descrição: Retorna o id da última ocorrência criada.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-numid	Int			X

Método: verifyTemplates.

Descrição: Verifica se o usuário logado tem acesso a campanha que está no template que o mesmo está tentando usar.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
c-numIdTemplate	Char		X
c-msg	Char			X

Árvore de páginas

apiCrmRegistroAcao - Api de Registro de Ação

Documento de API

Objetivo

Tabelas Temporárias

Métodos