Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | lap/mla0007.p |
Considerações Gerais
Objetivo
O objetivo desta API é aprovar/reprovar/reaprovar uma pendência do MLA.
Funcionamento
A API fornece basicamente duas ações: movimentação de pendência (aprovar/reprovar/reaprovar) e listagem das rejeições cadastradas.
A sintaxe para a chamada da API, que deve ser de forma persistente:
run lap/mla0007.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 Negócio
Quando a API estiver executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
getCodRejeita |
Requisito | Nenhum |
Sintaxe | RUN getCodRejeita IN h-handle(OUTPUT TABLE tt-cod-rej-aprov). |
Descrição | Retorna todas as rejeições cadastradas no sistema. |
Retorno | A procedure retorna uma temp-table ( tt-cod-rej-aprov, que deve ser definida como mostrado abaixo. Esta temp-table contém dados das rejeições cadastradas no ERP (MLA0120). |
tt-cod-rej-aprov | Entrada/Saída |
Temp-table com as rejeições cadastradas no sistema | Saída |
Atributo | Tipo | Descrição | Obrigatório | Evolução |
iCodRejeita | INTEGER | Código da rejeição | Sim | Não se aplica |
cCodRejeita | CHARACTER | Descrição da rejeição | Sim | Não se aplica |
obriga-narrativa | LOGICAL | Informa se a narrativa de rejeição é obrigatória | Sim | Não se aplica |
aprovPendencia |
Requisito | Execução da procedure setPendencia. |
Sintaxe | run aprovPendencia in h-handle (input cNarrativa, input cSenhaUsuar, input cCodRejeicao, output l-log-erros). |
Descrição | Aprova, reprova ou reaprova uma pendência ou um grupo de pendências. |
Parâmetros | Tipo | Descrição |
cNarrativa | CHARACTER | Narrativa da aprovação/reprovação |
cSenhaUsuar | CHARACTER | Senha do usuário logado |
cCodRejeicao | CHARACTER | Código da Rejeição (apenas quando for REPROVAÇÃO) |
Retorno | l-log-erros: Flag de Ocorrência de erros (LOGICAL) |
setPendencia |
Requisito | Nenhum |
Sintaxe | run setPendencia in h-handle (input p-selecionados, input p-acao). |
Descrição | Determina qual(is) a(s) pendência(s) será(ão) movimentada(s). |
Parâmetros | Tipo | Descrição |
p-selecionados | CHARACTER | Número da(s) transação(ões) que será(ão) movimentadas. (Separador: , (vírgula)) |
p-acao | INTEGER | Código da ação que será executada: 1- Aprovar 2- Reprovar 3- Reaprovar |
Retorno | Não se aplica. |
aprovaPendPortal |
Requisito | Nenhum |
Sintaxe | RUN aprovaPendPortal IN h-mla0007(INPUT p-selecionados, INPUT p-acao, INPUT p-narrativa, INPUT p-senha-usuar, INPUT p-cod-rejeicao, OUTPUT p-log-erros, OUTPUT TABLE RowErrors). |
Descrição | Aprova, reprova ou reaprova uma pendência ou um grupo de pendências via Portal. |
Parâmetros | Tipo | Descrição |
p-selecionados | CHARACTER | Número da(s) transação(ões) que será(ão) movimentadas. (Separador: , (vírgula)) |
p-acao | INTEGER | Código da ação que será executada: 1- Aprovar 2- Reprovar 3- Reaprovar |
p-narrativa | CHARACTER | Narrativa de aprovação/reprovação |
p-senha-usuar | CHARACTER | (opcional) passar: “” (string vazia) |
p-cod-rejeicao | CHARACTER | Código da rejeição (Apenas quando for reprovação (p-acao=2, caso contrário passar 0). |
Retorno | p-log-erros: Flag de Ocorrência de erros (LOGICAL). RowErrors: Temp-table com os erros que ocorreram durante o processo de aprovação do documento. |
RowErrors | Entrada/Saída |
Temp-table com dados dos erros que ocorreram durante a movimentação da pendência. | Saída |
Atributo | Tipo | Descrição | Obrigatório | |
ErrorSequence | INTEGER | Sequencia do erro | Sim | |
ErrorNumber | INTEGER | Código do erro | Sim | |
ErrorDescription | CHARACTER | Descrição do erro | Sim | |
ErrorParameters | CHARACTER | Parâmetros da mensagem de erro | Não | |
ErrorType | CHARACTER | Tipo do erro | Sim | |
ErrorHelp | CHARACTER | Ajuda | Sim | |
ErrorSubType | CHARACTER | Subtipo do erro (ERROR,INFORMATION,WARNING, QUESTION) | Sim | |
aprovaPendPortal_2 |
Requisito | Nenhum |
Sintaxe | RUN aprovaPendPortal_2 IN h-mla0007(INPUT p-selecionados, INPUT p-acao, INPUT p-narrativa, INPUT p-senha-usuar, INPUT p-cod-rejeicao, OUTPUT p-log-sucesso, OUTPUT TABLE RowErrors). |
Descrição | Aprova, reprova ou reaprova uma pendência ou um grupo de pendências via Portal (Novo framework HTML). |
Parâmetros | Tipo | Descrição |
p-selecionados | CHARACTER | Número da(s) transação(ões) que será(ão) movimentadas. (Separador: , (vírgula)) |
p-acao | INTEGER | Código da ação que será executada: 1- Aprovar 2- Reprovar 3- Reaprovar |
p-narrativa | CHARACTER | Narrativa de aprovação/reprovação |
p-senha-usuar | CHARACTER | (opcional) passar: “” (string vazia) |
p-cod-rejeicao | CHARACTER | Código da rejeição (Apenas quando for reprovação (p-acao=2, caso contrário passar 0). |
Retorno | p-log-sucesso: Flag de sucesso na movimentação (LOGICAL) RowErrors: Temp-table com os erros que ocorreram durante o processo de aprovação do documento. |
RowErrors | Entrada/Saída |
Temp-table com dados dos erros que ocorreram durante a movimentação da pendência. | Saída |
Atributo | Tipo | Descrição | Obrigatório | |
ErrorSequence | INTEGER | Sequencia do erro | Sim | |
ErrorNumber | INTEGER | Código do erro | Sim | |
ErrorDescription | CHARACTER | Descrição do erro | Sim | |
ErrorParameters | CHARACTER | Parâmetros da mensagem de erro | Não | |
ErrorType | CHARACTER | Tipo do erro | Sim | |
ErrorHelp | CHARACTER | Ajuda | Sim | |
ErrorSubType | CHARACTER | Subtipo do erro (ERROR,INFORMATION,WARNING, QUESTION) | Sim | |
