Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

utp\utp00218.p

 

Considerações Gerais

 

Objetivo

API principal, genérica que será executada pelo servidor RPW. Essa API se encarregará de validar o programa que deve ser chamado para realizar a integração com o Datasul 11 e o center UMOV.ME.

 

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 sintaxe para a chamada da API é:

run utp/utp00218.p (input raw-param, input table tt-raw-digita).

 

A sintaxe para executar a API em modo persistente é:

run utp/utp00218.p (input raw-param, input table tt-raw-digita) 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.

 

Tabelas Temporárias 

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

RowErrors

Entrada/Saída

Tabela de Erros

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

ErrorSequence

Int

 

Sequência

 

 

ErrorNumber

Int

 

Número

 

 

ErrorDescription

Char

 

Descrição

 

 

ErrorParameters

Char

 

Parâmetros

 

 

ErrorType

Char

 

Tipo

 

 

ErrorHelp

Char

 

Ajuda

 

 

ErrorSubType

Char

 

Sub Tipo

 

 

tt-raw-digita

Entrada/Saída

Usuários do CRM para integração com UMOV.ME

 

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

raw-digita

raw

 

Parâmetros rpw

 

 

 

Método Negócio

 

setUmovme

Requisito

 

Sintaxe

Run setUmovme in h-handle (input table ttParamUmov, output table RowErrors).

Descrição

Programa genérico utilizado pelo Datasul 11 para que o rpw possa executar a integração com umov.me. Neste método será validado e executado o programa especificado no cadastro de aplicativos, sendo assim possível de ser utilizado pelas demais áreas, basta apenas seguir o padrão definido na DIS.

Parâmetros

Descrição

ttParamUmov

Parâmetros umov.me e rpw

RowErrors

Erros

Retorno

RowErrors