Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | pnp/pnapi003 |
Objetivo
A API, faz a integração entre o produto Pneus com o produto EMS, na parte do estoque.
Funcionamento
A API, recebe como parâmetros o tipo de movimento do estoque (Requisição/Devolução) e a temp-table com o registro de movimentação do pneu que deve ser integrado.
Busca-se o período do cálculo do médio em aberto, busca todas as informações necessárias para fazer a baixa em estoque (item).
Após criar o registro, chama a API de estoque (cep\ceapi001.p), que valida os registros, baixa do estoque e retorna o número da transação efetivada ou os erros ocorridos.
Os números das transações são guardados nos apontamentos de pneu e a ficha é atualizada como integrada com EMS.
1 – Não Integrado
2 – Integrado
A API roda somente na forma padrão, onde realiza-se a chamada através de um comando RUN normal, passando-se a temp-table e variáveis carregadas com as informações necessárias.
A sintaxe para a chamada da API/BO é:
Para requisição:
run pnp\pnapi003.p (input 28,
input table RowObject,
output table RowErrors append).
Para devolução:
run pnp\pnapi003.p (input 05,
input table RowObject,
output table RowErrors append).
Parâmetros
Nas variáveis de parâmetro de entrada e saída:
Parâmetro | Tipo | Formato | Descrição | Obrigatório | Evolução |
iEspDocto | integer | padrão | Espécie do movimento no estoque 05 – Devolução 28 - Requisição | Sim |
|
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
Tabela Temporária | Descrição | Entrada/Saída |
ttRowObject | Contém o registro do apontamento do pneu que fora atualizado. Esta temp-table é LIKE mpn-movto-pneu. | Entrada |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
r-rowid | rowid | padrão | Rowid do apontamento pneu | Sim |
|
Tabela Temporária | Descrição | Entrada/Saída |
RowErrors | Contém os erros ocorridos na API (Mesma temp-table utilizada para gerar erros pelas BOs) | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ErrorSequence | integer | padrão | Seqüência dos erros | Sim | 001 |
ErrorNumber | integer | padrão | Número do erro | Sim | 001 |
ErrorDescription | char | padrão | Descrição do erro | Sim | 001 |
ErrorParameters | char | padrão | Parâmetros passados para criar mensagem | Não | 001 |
ErrorType | char | padrão | Tipo do erro: WARNING: Aviso ERROR: Erro | Sim | 001 |
ErrorHelp | char | padrão | Texto de ajuda do erro | Sim | 001 |
ErrorSubType | char | padrão | Sub Tipo da mensagem de erro | Não | 001 |
| Parâmetros | Descrição |
| Não Contém |
|
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. |