Retorno e criação de follow-up's de documentos

Características do Requisito

Objetivo

Retornar/Criar dados referentes aos followup's de documentos

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 ccp/ccapi355.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.

ttFollowUp					Entrada/Saída
Informações dos follow-up’s de documentos.					Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
origem	CHARACTER	x(30)	Descrição do documento de origem	Não
numero	INTEGER	>>>,>>>,>>>,>>9	Número do documento	Não
responsavel	CHARACTER	x(8)	Responsável	Sim
data	DATE	99/99/9999	Data do follow-up	Sim
hora	CHARACTER	99:99:99	Hora do follow-up	Sim
fornecedor	INTEGER	>>>>>>>>9	Fornecedor	Não
item	CHARACTER	X(16)	Código do item	Não
comentario	CHARACTER	X(15000)	Texto do follow-up	Sim
sequencia	INTEGER	>>9	Sequência do item	Não
epc-value	CHARACTER	x(200)	Campo para customização	Não

ttFollowUpOrig					Entrada/Saída
Informações do follow-up de documentos a ser criado.					Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
doc	INTEGER	>9	Tipo do documento	Sim
docNumber	INTEGER	>>>,>>>,>>>,>>9	Número do documento	Não
item	CHARACTER	X(16)	Código do item	Não
seqItem	INTEGER	>>9	Sequência do item	Não
vendor	INTEGER	>>>>>>>>9	Emitente	Não
seqQuote	INTEGER	>>9	Sequência da cotação ou ordem de compra no caso de pedido	Não
comment	CHARACTER	X(15000)	Texto do follow-up	Sim

RowErrors					Entrada/Saída
Erros ocorridos durante o processo					Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ErrorSequence	INTEGER		Sequência do erro	Sim
ErrorNumber	INTEGER		Número do erro	Sim
ErrorDescription	CHARACTER		Descrição do erro	Não
ErrorParameters	CHARACTER		Parâmetros para o erro	Não
ErrorType	CHARACTER		Tipo de erro	Não
ErrorHelp	CHARACTER		Texto de ajuda	Não
ErrorSubType	CHARACTER		Sub-tipo do erro	Não

Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

REST_GET_getFollowUp
Requisito	Nenhum
Sintaxe	RUN REST_GET_getFollowUp in handle (INPUT <integer>, INPUT <integer>, INPUT <character>, INPUT <integer>, INPUT <integer>, INPUT <integer>, OUTPUT TABLE <temp-table>, OUTPUT TABLE <temp-table>).
Descrição	Retorna os follow-up's de um documento.
	Parâmetros	Descrição
	QP_doc QP_docNumber QP_item QP_seqItem QP_vendor QP_seqQuote ttFollowUp RowErrors	Tipo do documento 1 - Requisição de Estoque 2 - Solicitação de Compra 3 - Solicitação de Cotação 4 - Ordem de Compra 5 - Cotação 6 - Pedido de Compra Número do documento Código do item Sequência do item Fornecedor Sequência da cotação ou ordem de compra no caso de pedido Follow-ups de documentos Erros ocorridos no processo.
Retorno	Retorna uma temp-table contendo os follow-up’s do documento e outra contendo os erros ocorridos no processo.

REST_POST_addFollowUp
Requisito	Nenhum
Sintaxe	RUN REST_POST_ addFollowUp in handle (INPUT TABLE <temp-table>, OUTPUT TABLE <temp-table>).
Descrição	Criar um follow-up.
	Parâmetros	Descrição
	ttFollowUpOrig RowErrors	Follow-up de documentos a ser criado. Erros ocorridos no processo
Retorno	Retorna uma temp-table contendo os erros ocorridos no processo.