Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | crmapi/ apiCrmTemplateNotific.p |
Considerações Gerais
Objetivo
Listar e relacionar os processos do ECM a ação da campanha no CRM. Verificar e validar a parametrização referente a integração com o ECM.
Funcionamento
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 é:
run crmapi/ apiCrmTemplateNotific.p. |
A sintaxe para executar a API em modo persistente é:
run crmapi/ apiCrmTemplateNotific.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 Básico
Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
piSave | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Método responsável por salvar a configuração de layout. | |
Parâmetros | Descrição | |
cLayoutLiberacao | Layout de liberação do pedido. | |
| cLayoutAprovacao | Layout de aprovação do pedido. |
| cLayoutReprovacao | Layout de reprovação do pedido. |
| cLayoutEfetivacao | Layout de efetivação do pedido. |
| cLayoutAlocacao | Layout de alocação do pedido. |
| cLayoutDesalocacao | Layout de desalocação do pedido. |
| cLayoutSeparacao | Layout de separação do pedido. |
| cLayoutFaturamento | Layout de faturamento do pedido. |
| cLayoutCancelamentoNota | Layout de cancelamento da nota do pedido. |
| cLayoutCancelamento | Layout de cancelamento do pedido. |
| cLayoutSuspensao | Layout de suspensão do pedido. |
| cLayoutReativacao | Layout de reativação do pedido. |
| cLayoutAprovacaoCredito | Layout de aprovação de crédito do pedido. |
| cLayoutReprovacaoCredito | Layout de reprovação de crédito do pedido. |
| cLayoutAprovacaoPendenteInfo | Layout de aprovação de crédito pendente de informação. |
| cLayoutAprovacaoComercial | Layout de aprovação comercial do pedido. |
| cLayoutReprovacaoComercial | Layout de reprovação comercial do pedido. |
| cLayoutSuspensaoComercial | Layout de suspensão comercial do pedido. |
Retorno |
|
piLoad | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Método responsável por buscar a configuração do leiaute. | |
Parâmetros | Descrição | |
Não contém | - | |
Retorno | Out / cLayoutLiberacao / Layout de liberação do pedido. Out / cLayoutAprovacao / Layout de aprovação do pedido. Out / cLayoutReprovacao / Layout de reprovação do pedido. Out / cLayoutEfetivacao / Layout de efetivação do pedido. Out / cLayoutAlocacao / Layout de alocação do pedido. Out / cLayoutDesalocacao / Layout de desalocação do pedido. Out / cLayoutSeparacao / Layout de separação do pedido. Out / cLayoutFaturamento / Layout de faturamento do pedido. Out / cLayoutCancelamentoNota / Layout de cancelamento da nota do pedido. Out / cLayoutCancelamento / Layout de cancelamento do pedido. Out / cLayoutSuspensao / Layout de suspensão do pedido. Out / cLayoutReativacao / Layout de reativação do pedido. Out / cLayoutAprovacaoCredito / Layout de aprovação de crédito do pedido. Out / cLayoutReprovacaoCredito / Layout de reprovação de crédito do pedido. Out / cLayoutAprovacaoPendenteInfo / Layout de aprovação de crédito pendente de informação. Out / cLayoutAprovacaoComercial / Layout de aprovação comercial do pedido. Out / cLayoutReprovacaoComercial / Layout de reprovação comercial do pedido. Out / cLayoutSuspensaoComercial / Layout de suspensão comercial do pedido. |