Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | fch\fchcrm\fchcrm0015.p |
Tabelas Temporárias
Atributos das tabelas temporárias de entrada e saída:
RowErrors | Tabela de Erros |
Atributo | Tipo | Formato | Descrição | Obr. |
ErrorSequence | Int | | Sequência | |
ErrorNumber | Int | | Número | |
ErrorDescription | Char | | Descrição | |
ErrorParameters | Char | | Parâmetros | |
ErrorType | Char | | Tipo | |
ErrorHelp | Char | | Ajuda | |
ErrorSubType | Char | | Sub Tipo | |
ttOutlookAccount | |
Atributo | Tipo | Formato | Descrição | Obr. |
pType | Char | | Tipo de Conta | |
idERP | Char | | Identificador da conta no ERP | |
idCRM | Char | | Identificador da conta no CRM | |
born | Char | | Data de nascimento / fundação | |
treatment | Char | | Forma de tratamento | |
nickName | Char | | Nome abreviado | |
homePage | Char | | Endereço do website | |
email2 | Char | | E-mail secundário | |
email1 | Char | | E-mail primário | |
job | Char | | Profissão | |
company | Char | | Nome da empresa onde trabalha | |
work | Char | | Cargo | |
department | Char | | Departamento | |
fullName | Char | | Nome completo / Razão social | |
tAdrress2 | Char | | Informe de endereço comercial | |
address2 | Char | | Endereço comercial | |
tAdrress1 | Char | | Informe de endereço residencial | |
address1 | Char | | Endereço residencial | |
tPhone3 | Char | | Informe de telefone comercial | |
phone3 | Char | | Telefone comercial | |
tPhone2 | Char | | Informe de telefone residencial | |
phone2 | Char | | Telefone residencial | |
tPhone1 | Char | | Informe de telefone celular | |
phone1 | Char | | Telefone celular | |
ttOutloookCamp | |
Atributo | Tipo | Formato | Descrição | Obr. |
iIdCamp | Dec | | Identificador sequencial da campanha | |
iIdAct | Dec | | Identificador sequencial da ação | |
cDesc | Char | | Descrição / Nome | |
cValidate | Char | | Data de Validade (dd/mm/yy) | |
bDefault | Log | | Default para registro de e-mail | |
iActCamp | Dec | | Identificador sequencial da ação da campanha | |
Métodos
Métodos básicos
Método: registerEmailActionOnOutlook.
Descrição: Registra o e-mail do Outlook como uma ação de relacionamento no CRM.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
cUser | Char | | X | | | Login do usuário |
cPass | Char | | X | | | Senha do usuário |
iCamp | Dec | | X | | | Identificador sequencial da campanha |
iAct | Dec | | X | | | Identificador sequencial da ação |
cEmail | Char | | X | | | Conteúdo do e-mail |
iAcc | Dec | | X | | | Identificador da conta no CRM |
cAccEmail | Char | | X | | | E-mail da conta |
iType | Dec | | X | | | Tipo de e-mail (Enviado x Recebido) |
out | Log | | | X | | Indicador de sucesso |
Método: authenticate.
Descrição: Autentica o usuário informado no Outlook no banco de dados do CRM e Foundation.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
cUser | Char | | X | | | Login do usuário |
cPass | Char | | X | | | Senha do usuário |
out | Log | | | X | | Indicador de sucesso |
Método: getAllCampaignToOutlook.
Descrição: Busca todas as campanhas e ações da campanha que o usuário informado tem acesso e que não estejam vencidas.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
cUser | Char | | X | | | Login do usuário |
cPass | Char | | X | | | Senha do usuário |
ttOutlookCampaing | TT | | | X | | Campanhas e ações da campanha para relacionamento. |
Método: getAllAccountsToOutlook.
Descrição: Busca todas as contas que o usuário informado possuir acesso e que estejam marcadas com a flag “integra outlook”.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
cUser | Char | | X | | | Login do usuário |
cPass | Char | | X | | | Senha do usuário |
bAccount | Log | | X | | | Flag para busca de contas |
bContact | Log | | X | | | Flag para busca de contatos |
bLead | Log | | X | | | Flag para busca de leads |
fullSync | Log | | X | | | Tipo de sincronização (total ou parcial) |
ttOutlookAccount | TT | | | X | | Registros de pessoas |
Método: getRowErrors.
Descrição: Procedure padrão de erros.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
RowErrors | Tt | | | X | | Erros |
Método: createRowErrors.
Descrição: Cria erros em execução.
Requisitos: Nenhum.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pErrorNumber | Int | | X | | | Número do Erro |
pProgramName | Char | X(50) | X | | | Nome do Programa |
#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))