Documento de API

Uma API (Application Programming Interface) é um programa que recebe parâmetros específicos e executa uma tarefa determinada no Datasul EMS Framework. A tarefa pode ser uma atualização ou pode retornar informações, resultados de um cálculo ou um gráfico. Uma API é uma interface aberta para as funções de negócio do Datasul EMS Framework.

O DBO é um programa Progress que contém a lógica de negócio e acesso a dados para uma tabela do banco de dados. É uma evolução das APIs dos produtos Datasul.

 Objetivo

Responsável por efetivar as transferências entre os endereços, executando a saída do saldo do endereço selecionado e criando a entrada do saldo no novo endereço.

Funcionamento

Esta API irá receber vários parâmetros e entre eles uma tabela com todas as etiquetas que podem ser transferidas.

DEF INPUT  PARAM pRwMovto                        AS ROWID                              NO-UNDO.

à ID da tabela wm-box-movto.

DEF INPUT  PARAM pIdBoxDestino                   LIKE wm-box.id-box                    NO-UNDO.

à Informe o ID box destino, qdo saída = 0.

DEF INPUT  PARAM pCodUsuario                     LIKE usuario-scm.usuario              NO-UNDO.

à Usuário da movimentação wm-box-movto.

DEF INPUT  PARAM pCodEqpto                       LIKE wm-tarefa-docto.cod-equipamento  NO-UNDO.

à Código do equiámento.

DEF INPUT  PARAM pCodColetor                     LIKE wm-tarefa-docto.cod-coletor      NO-UNDO.

à Código do coletor.

DEF INPUT  PARAM pHoraInicio                     LIKE wm-tarefa-docto.hr-inicio-tarefa NO-UNDO.

à Hora de início Tarefa.

DEF INPUT  PARAM pSobreporBox                    AS   LOGICAL                          NO-UNDO.

à True ou false: Define se sobrepoe o id do Box.

DEF INPUT  PARAM pIdAgrupador                    LIKE wm-etiqueta.id-etiqueta          NO-UNDO.

à informar 0, parâmetro não usado.

DEF INPUT  PARAM i-ind-status-saldo-origem       LIKE wm-box-saldo.ind-status-saldo    NO-UNDO.

à

DEF OUTPUT PARAM o-ind-status-saldo-origem       LIKE wm-box-saldo.ind-status-saldo    NO-UNDO.

DEF INPUT  PARAM i-id-movto-box-saldo            LIKE wm-box-saldo.id-movto            NO-UNDO.

DEF OUTPUT PARAM o-id-movto-box-saldo            LIKE wm-box-saldo.id-movto            NO-UNDO.

DEF INPUT  PARAM TABLE                           FOR tt-etiqueta.

DEF OUTPUT PARAM TABLE                           FOR RowErrors.

A API irá realizar uma séria de validações para determinar se a transferência é válida. Ao final, caso não ocorra nenhum erro, irá gerar uma saída no endereço origem selecionado com a quantidade digitada e uma entrada desta quantidade no endereço destino informado.

A sintaxe para a chamada da API/BO é:

/* executa saida */
RUN wmp/wm9091.p (INPUT r-box-movto,
                          INPUT 0, /* box destino */
                          INPUT c-usuario,
                          INPUT "", /* equipamento */
                          INPUT "", /* coletor */
                          INPUT TIME, /* hora inicio */
                          INPUT NO, "Indica se é para sobrepor box"
                          INPUT 0, Id do agrpador
                          INPUT i-ind-status-saldo-origem,
                          OUTPUT o-ind-status-saldo-origem,
                          INPUT i-id-movto-box-saldo, 
                          OUTPUT o-id-movto-box-saldo,
                          INPUT TABLE tt-etiqueta,
                          OUTPUT TABLE RowErrors).

Tabelas Temporárias

Temp-Table tt-etiqueta: Informações da wm-etiqueta.

©2002 Datasul. Todos os direitos reservados.

Não se aplica.