Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | utp/utp00508.p |
Considerações Gerais
Objetivo
Integração rpw da agenda do represanten (datasul 11) com 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/BO é:
run utp/utp00508.p. |
A execução na forma persistente ...
A sintaxe para executar a API/BO em modo persistente é:
run utp/utp00508.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.
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 | Inteiro |
| Sequência |
|
|
ErrorNumber | Inteiro |
| Número |
|
|
ErrorDescription | Character |
| Descrição |
|
|
ErrorParameters | Character |
| Parâmetros |
|
|
ErrorType | Character |
| Tipo |
|
|
ErrorHelp | Character |
| Ajuda |
|
|
ErrorSubType | Character |
| Sub Tipo |
|
|
Método Básico
Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
Método Negócio
execAgendaRPW | ||
Requisito |
| |
Sintaxe | Run execAgendaRPW in handle (input table ttParamUmov, output table RowErrors). | |
Descrição | Método principal executado pelo servidor rpw, que irá chamar a integração do crm(Datasul 11) com UMOV.ME | |
Parâmetros | Descrição | |
ttParamUmov | Parâmetros | |
| RowErrors |
|
Retorno | RowErrors |
afterUpInsertUser | ||
Requisito |
| |
Sintaxe | Run afterUpInsertUser in handle (input table ttAplicatMovUsuar, output table RowErrors). | |
Descrição | Método padrão chamdo ao salvar o usuário que tem acesso ao aplicativo. | |
Parâmetros | Descrição | |
ttAplicatMovUsuar | Parâmetros | |
RowErrors |
| |
Retorno | RowErrors |
beforeUpInsertUser | ||
Requisito |
| |
Sintaxe | Run beforeUpInsertUser in handle (input table ttAplicatMovUsuar, output table RowErrors). | |
Descrição | Método padrão chamdo ao salvar o usuário que tem acesso ao aplicativo. | |
Parâmetros | Descrição | |
ttAplicatMovUsuar | Parâmetros | |
RowErrors |
| |
Retorno | ttAplicatMovUsuar |