Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | lap/mla0010.p |
Objetivo
O objetivo desta API é retornar informações dos usuários alternativos para o Portal MLA (HTML5).
Funcionamento
A API fornece basicamente a listagem de usuários alternativos.
A sintaxe para a chamada da API, que deve ser de forma persistente:
run lap/mla0010.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:
REST_GET_getAlternatives | |||
Requisito | Nenhum. | ||
Sintaxe | RUN REST_GET_getAlternatives IN h-handle(INPUT cCodUsuar, INPUT cCodUsuarAltern, OUTPUT TABLE ttUsuariosAlternativos). | ||
Descrição | Através dos parâmetros passados para a procedure, ela retorna o(s) registro(s) para listagem dos usuários alternativos. | ||
Parâmetros | Tipo | Descrição | |
cCodUsuar | CHARACTER | Código do usuário aprovador. | |
cCodUsuarAltern | CHARACTER | Código do usuário alternativo. Obs: opcional. Quando passado “?” ele retorna todos os usuários alternativos do usuário aprovador passado no parâmetro cCodUsuar. Quando passado algum código de usuário alternativo retrona apenas os dados deste usuário alternativo. | |
Retorno | A procedure retorna uma temp-table (ttUsuariosAlternativos), que deve ser definida como mostrado abaixo. Nesta temp-table contém dados do(s) usuário(s) alternativo(s). |
ttUsuariosAlternativos | Entrada/Saída | |||
Temp-table com dados dos usuários alternativos | Saída | |||
Atributo | Tipo | Descrição | Obrigatório | Evolução |
cod-usuar | CHARACTER | Código do usuário aprovador | Sim | Não se aplica |
nome-usuar | CHARACTER | Nome do usuário alternativo | Sim | Não se aplica |
validade-ini | DATE | Inicio da validade de aprovação | Sim | Não se aplica |
validade-fim | DATE | Final da validade de aprovação | Sim | Não se aplica |
cod-usuar-altern | CHARACTER | Código do usuário alternativo | Sim | Não se aplica |
ep-codigo | CHARECTER | Código da empresa do usuário alternativo | Sim | Não se aplica |
r-rowid | ROWID | Rowid | sim | Não se aplica |