Documento de API

Considerações Gerais

Objetivo

Esta API tem como objetivo o Envio de email de notificação de pedidos de venda.

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 execução na forma persistente é realizada através da chamada de um comando RUN conforme exemplo a seguir.

A sintaxe para executar a API em modo persistente é:

RUN pdp/pdapi513e.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.

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

piMandaEmailPedido
Requisito	Nenhum
Sintaxe	RUN piMandaEmailPedido IN handle (INPUT <integer>, INPUT <character>, INPUT <character>, OUTPUT TABLE RowErrors).
Descrição	Método para uso interno que e-nvia o email para o cliente com a situação do pedido.
	Parâmetros	Descrição
	nrPedido	Indica o número do pedido que deve ser notificado ao cliente
	cStatus	Indica a situação do pedido que será montado na mensagem
	cIdEvento	Indica o ID do evento para fins de customização
	RowErrors	Temp table com erros ocorridos no envio de email
Retorno	A API irá retornar caso existam, os erros que ocorreram durante o processo

montaMensagem
Requisito	Nenhum
Sintaxe	RUN montaMensagem IN handle (INPUT <character>).
Descrição	Método para uso interno, monta o texto da mensagem.
	Parâmetros	Descrição
	cStatus	Indica a situação do pedido que será montado na mensagem
Retorno	Nenhum

piMandaEmailCredito
Requisito	Nenhum
Sintaxe	RUN piMandaEmailCredito IN handle (INPUT <character>, INPUT <character> ).
Descrição	Método para uso interno, monta o texto da mensagem.
	Parâmetros	Descrição
	nrPedCli	Indica o número do pedido do cliente
	nomeAbrev	Indica o nome abreviado do cliente
Retorno	Nenhum

piMandaEmailComercial
Requisito	Nenhum
Sintaxe	RUN piMandaEmailComercial IN handle (INPUT <character>, INPUT <character> ).
Descrição	Envia e-mail de notificação do pedido quando há atividade na avaliação comercial do pedido
	Parâmetros	Descrição
	nrPedCli	Indica o número do pedido do cliente
	nomeAbrev	Indica o nome abreviado do cliente
Retorno	Nenhum

piMandaEmailEvento
Requisito	Nenhum
Sintaxe	RUN piMandaEmailEvento IN handle (INPUT <character>, INPUT <character>, INPUT <character> ).
Descrição	Envia e-mail de notificação do pedido por evento
	Parâmetros	Descrição
	nrPedCli	Indica o número do pedido do cliente
	nomeAbrev	Indica o nome abreviado do cliente
	cId	Indica o evento do pedido que deve ser notificado por e-mail ao cliente
Retorno	Nenhum

simpleStartProcess
Requisito	Nenhum
Sintaxe	RUN simpleStartProcess IN handle (INPUT <character>, INPUT <character>, OUTPUT <character>, OUTPUT <logical> OUTPUT <logical>).
Descrição	Inicia uma nova instancia do workflow WF.APP no ECM
	Parâmetros	Descrição
	p-nr-pedcli	Indica o número do pedido do cliente
	p-nome-abrev	Indica o nome abreviado do cliente
	p-nr-processo	Identifica o número do processo gerado no ECM
	p-l-terminou	Indica que o processo terminou e não ficou pendente no ECM
	p-l-aprovado	Indica que o processo terminou, sendo assim o mesmo fica como aprovado
Retorno	Retorna o número do processo gerado no ECM e seu estado

setResponsibleUser
Requisito	Nenhum
Sintaxe	RUN setResponsibleUser IN handle (INPUT <character>, INPUT <character>, OUTPUT <character>).
Descrição	Busca no ECM qual o usuário responsável pela aprovação do pedido de venda
	Parâmetros	Descrição
	p-nr-pedcli	Indica o número do pedido do cliente do pedido de venda.
	p-nome-abrev	Indica o nome abreviado do pedido de venda
	pcUsuarioResponsavel	Retorna o usuário responsável pela aprovação
Retorno	A API irá retornar o usuário responsável pela aprovação

saveAndSendTask
Requisito	Nenhum
Sintaxe	RUN saveAndSendTask IN handle (INPUT <character>, INPUT <integer>, INPUT <character extent>, INPUT <character>, INPUT <character>, INPUT <character>, OUTPUT TABLE RowErrors).
Descrição	Movimenta o processo de aprovação no ECM
	Parâmetros	Descrição
	p-processo	Indica o tipo do processo: reprovação, aprovação, assumir ou transferir
	p-choosedState	Indica o código do estado destino do processo do workflow.
	p-colleagueIds	Indica os usuários responsáveis pela próxima tarefa.
	p-comments	Comentário relativo ao processo
	p-nr-pedcli	Indica o número do pedido do cliente
	p-nome-abrev	Indica o nome abreviado do cliente
	RowErrors	Temp-table com os problemas ocorridos no processo
Retorno	A API irá retornar caso existam, os erros ocorridos durante o processo

cancelInstance
Requisito	Nenhum
Sintaxe	RUN cancelInstance IN handle (INPUT <character>, INPUT <character>).
Descrição	Cancela o processo de aprovação no ECM
	Parâmetros	Descrição
	p-nr-pedcli	Indica o número do pedido do cliente
	p-nome-abrev	Indica o nome abreviado do cliente
Retorno	Nenhum

startCancelationProcess
Requisito	Nenhum
Sintaxe	RUN startCancelationProcess IN handle (INPUT <character>, INPUT <character>, INPUT <character>).
Descrição	Inicia a solicitação de cancelamento do pedido de venda
	Parâmetros	Descrição
	p-nr-pedcli	Indica o número do pedido do cliente
	p-nome-abrev	Indica o nome abreviado do cliente
	p-motivo	Indica o motivo de cancelamento do pedido de venda
Retorno	Nenhum