Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicolap/mla0009.p


Objetivo


O objetivo desta API é obter as informações utilizadas pelo portal do MLA (Novo Framework HTML).


Funcionamento


A API fornece basicamente informações da empresa selecionada, da ordenação usada na listagem dos documentos, do histórico de aprovações, dos documentos do usuário e dos totalizadores dos documentos.

Deve ser declara a include "{lap/mla0009.i}" que possui a declaração de todas as tabelas temporárias utilizadas nos métodos da api.

A sintaxe para a chamada da API, que deve ser de forma persistente:


run lap/mla0009.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:

getDadosEmpresa

Requisito

Nenhum.

Sintaxe

RUN  getDadosEmpresa IN h-handle(OUTPUT TABLE tt-empresas-usuar,

                                                             OUTPUT p-cod-empresa,

                                                             OUTPUT p-razao-social).

Descrição

Retorna informações da empresa logada e lista de empresas do usuário.

Obs: Para acessar este método via REST usar a procedure REST_GET_getDadosEmpresa.

Retorno

tt-empresas-usuar: temp-table com as empresas do usuário.

p-cod-empresa (CHARACTER): Código da empresa selecionada.

p-razao-social (CHARACTER): Razão social da empresa selecionada.


tt-empresas-usuar

Entrada/Saída

Temp-table com dados das empresas do usuário

Saída

Atributo

Tipo

Descrição

Obrigatório

Evolução

c-cod-empresa

CHARACTER

Código da empresa

Sim

Não se aplica

c-razao-social

CHARACTER

Razão social da empresa

Sim

Não se aplica

getSortDefault

Requisito

Nenhum.

Sintaxe

RUN  getSortDefault IN h-handle(OUTPUT i-sort).

Descrição

Retorna a ordenação padrão usada na listagem dos documentos para o usuário em questão

Obs: Para acessar este método via REST usar a procedure REST_GET_getSortDefault.

Retorno

i-ordering: tipo de ordenação

1-       Mais recentes

2-       Mais antigas

3-       Maior valor

4-       Menor valor

5- Maior empresa

6- Menor empresa

getTotalizadoresPorDocumento

Requisito

Nenhum.

Sintaxe

RUN getTotalizadoresPorDocumento in h-handle (input  i-tipo,

                                                                                 input dtIni,

                                                                                 input dtFim,

                                                                                 output table ttDocuments).

Descrição

Retorna para cada documento que o usuário tem permissão de acesso, o número de pendências como principal e o número de pendências alternativo.

Obs: Para acessar este método via REST usar a procedure REST_GET_getTotalizadoresPorDocumento

Parâmetros

Descrição

i-tipo

Tipo da pendência.

1-       Principais e alternativas (com mestre junto)

2-       Saída

dtIni

Data de início para consideração dos históricos.

dtFim

Data de término para consideração dos históricos.

Retorno

ttDocuments: Temp-table com os documentos e seus totais.


Exemplo de registro que poderiam existir na ttDocuments:


ttDocuments.cod-tip-doc = 2

ttDocuments.desc-tip-doc = "Solicitação de Compra - Total"

ttDocuments.nr-doc-pend-aprov-prin = 2

ttDocuments.nr-doc-pend-aprov-alter = 0

ttDocuments.nr-doc-pend-aprov-mes = 0

ttDocuments.nr-doc-pend-aprov-total = 2

ttDocuments.nr-doc-pend-aprov-saida = 0


ttDocuments.cod-tip-doc = 5

ttDocuments.desc-tip-doc = "Cotação de Materiais"

ttDocuments.nr-doc-pend-aprov-prin = 19

ttDocuments.nr-doc-pend-aprov-alter = 0

ttDocuments.nr-doc-pend-aprov-mes = 0

ttDocuments.nr-doc-pend-aprov-total = 19

ttDocuments.nr-doc-pend-aprov-saida = 0

               

getTotalizadoresPorDocumentoEmpresaEstab

Requisito

Nenhum.

Sintaxe

RUN getTotalizadoresPorDocumentoEmpresaEstab in h-handle (input epCodigo,

input codEstabel,

input  i-tipo,

input dtIni,

input dtFim,

output table ttDocuments).

Descrição

Retorna para cada documento que o usuário tem permissão de acesso, o número de pendências como principal e o número de pendências alternativo, considerando a empresa e estabelecimento.

Obs: Para acessar este método via REST usar a procedure REST_GET_getTotalizadoresPorDocumentoEmpresaEstab

Parâmetros

Descrição

epCodigoCódigo da empresa (Se passar em branco, considera todas)
codEstabelCódigo do estabelecimento (Se passar em branco, considera todos)

i-tipo

Tipo da pendência.

1-       Principais e alternativas (com mestre junto)

2-       Saída

dtIni

Data de início para consideração dos históricos.

dtFim

Data de término para consideração dos históricos.

Retorno

ttDocuments: Temp-table com os documentos e seus totais.


Exemplo de registro que poderiam existir na ttDocuments:


ttDocuments.cod-tip-doc = 2

ttDocuments.desc-tip-doc = "Solicitação de Compra - Total"

ttDocuments.nr-doc-pend-aprov-prin = 2

ttDocuments.nr-doc-pend-aprov-alter = 0

ttDocuments.nr-doc-pend-aprov-mes = 0

ttDocuments.nr-doc-pend-aprov-total = 2

ttDocuments.nr-doc-pend-aprov-saida = 0


ttDocuments.cod-tip-doc = 5

ttDocuments.desc-tip-doc = "Cotação de Materiais"

ttDocuments.nr-doc-pend-aprov-prin = 19

ttDocuments.nr-doc-pend-aprov-alter = 0

ttDocuments.nr-doc-pend-aprov-mes = 0

ttDocuments.nr-doc-pend-aprov-total = 19

ttDocuments.nr-doc-pend-aprov-saida = 0

ttDocuments

Entrada/Saída

Temp-table com os totalizadores dos documentos.

Saída

Atributo

Tipo

Descrição

Obrigatório

Evolução

cod-tip-doc

INTEGER

Código da empresa

Sim

Não se aplica

desc-tip-doc

CHARACTER

Razão social da empresa

Sim

Não se aplica

nr-doc-pend-aprov-prin

INTEGER

Total de pendências principais

Sim

Não se aplica

nr-doc-pend-aprov-alter

INTEGER

Total de pendências alternativas

Sim

Não se aplica

nr-doc-pend-aprov-mesINTEGERTotal de pendências como mestreSimNão se aplica

nr-doc-pend-aprov-total

INTEGER

Total de pendências

Sim

Não se aplica

nr-doc-pend-aprov-saida

INTEGER

Total de pendências do histórico.

Sim

Não se aplica

getHistoricoAprovacoes

Requisito

Nenhum.

Sintaxe

RUN getHistoricoAprovacoes in h-handle (input p-nr-transacao,

                                                                    output table tt-historico-aprov).

Descrição

Retorna o histórico de aprovações do documento.

Obs: Para acessar este método via REST usar a procedure REST_GET_getHistoricoAprovacoes.

Parâmetros

Descrição

p-nr-transacao

Número de transação da pendência do MLA

Retorno

tt-historico-aprov: Temp-table com histórico de aprovações do documento.

tt-historico-aprov

Entrada/Saída

Temp-table com o histórico de aprovações do documento.

Saída

Atributo

Tipo

Descrição

Obrigatório

Evolução

nivel

INTEGER

Nível de Aprovação

Sim

Não se aplica

desc-nivel

CHARACTER

Descrição do nível de aprovação.

Sim

Não se aplica

cod-aprovador

CHARACTER

Código do usuário aprovador

Sim

Não se aplica

nome-aprovador

CHARACTER

Nome do usuário aprovador

Sim

Não se aplica

data-aprovacao

DATE

Data de aprovação/rejeição

Sim

Não se aplica

hora-aprovacao

CHARACTER

Hora da aprovação/rejeição

Sim

Não se aplica

narrativa

CHARACTER

Narrativa de aprovação/rejeição.

Sim

Não se aplica

getDocumentosDoUsuario

Requisito

Nenhum.

Sintaxe

RUN getDocumentosDoUsuario in h-handle (output table ttDocs).

Descrição

Retorna os documentos que o usuário tem permissão.

Obs: Para acessar este método via REST usar a procedure REST_GET_getDocumentosDoUsuario.

Retorno

ttDocs: Temp-table com a lista de documentos do usuário.

ttDocs

Entrada/Saída

Temp-table com a lista de documentos do usuário

Saída

Atributo

Tipo

Descrição

Obrigatório

Evolução

cod-tip-doc

INTEGER

Código do Documento

Sim

Não se aplica

desc-tip-doc

CHARACTER

Nome do documento

Sim

Não se aplica

getDetalhePendencia

Requisito

Nenhum.

Sintaxe

RUN  getDetalhePendencia IN h-handle(INPUT p-nr-transacao,

                                                             OUTPUT TABLE tt-detalhe-pendencia,

                                                             OUTPUT TABLE tt-chave).

Descrição

Retorna informações detalhadas de uma pendência.

Obs: Para acessar este método via REST usar a procedure REST_GET_getDetalhePendencia.

Retorno

tt-detalhe-pendencia: temp-table com as informações detalhadas da pendência.

tt-chave: temp-table com a chave formatada da pendência.

tt-detalhe-pendencia

Entrada/Saída

Temp-table com as informações detalhadas da pendência.

Saída

Atributo

Tipo

Descrição

Obrigatório

Evolução

ep-codigo

INTEGER

Código do Documento

Sim

Não se aplica

desc-ep

CHARACTER

Descrição Empresa

Sim

Não se aplica

nr-transIntegerNúmero da transaçãoSimNão se aplica
cod-estabelCHARACTERCódigo estabelecimentoSimNão se aplica
desc-estabelCHARACTERDescrição EstabelecimentoSimNão se aplica
dt-geracaoDATEData de geraçãoSimNão se aplica
hr-geracaoCHARACTERHora de geraçãoSimNão se aplica
cod-tip-docINTEGERCódigo documentoSimNão se aplica
desc-docCHARACTERDescrição documentoSimNão se aplica
dt-aprovaDATEData de aprovaçãoNãoNão se aplica
hr-aprovaCHARACTERHora de aprovaçãoNãoNão se aplica
motivo-docCHARACTERMotivoNãoNão se aplica
dt-rejeitaDATEData de rejeiçãoNãoNão se aplica
hr-rejeitaCHARACTERHora de rejeiçãoNãoNão se aplica
motivo-histCHARACTERHistóricoNãoNão se aplica
dt-reaprovaDATEData de reaprovaçãoNãoNão se aplica
hr-reaprovaCHARACTERHora de reaprovaçãoNãoNão se aplica
cod-usuar-transCHARACTERCódigo usuário alternativoSimNão se aplica
nome-usuar-transCHARACTERNome usuário alternativoSimNão se aplica
valor-docDECIMALValor documentoSimNão se aplica
ind-tip-aprovINTEGERTipo de aprovaçãoSimNão se aplica
desc-tip-aprovCHARACTERDescrição tipo de aprovaçãoSimNão se aplica
cod-usuar-docCHARACTERUsuário documentoSimNão se aplica
nome-usuar-docCHARACTERNome usuário documentoSimNão se aplica
cod-lotacao-transCHARACTERCódigo LotaçãoSimNão se aplica
desc-lotacao-transCHARACTERDescrição Lotação TransaçãoSimNão se aplica
cod-usuarCHARACTERAprovadorSimNão se aplica
nome-usuarCHARACTERNome aprovadorSimNão se aplica
cod-lotacao-docCHARACTERLotação DocumentoSimNão se aplica
desc-lotacao-docCHARACTERDescrição Lotação DocumentoSimNão se aplica
cod-usuar-alternCHARACTERAlternativoNãoNão se aplica
nome-usuar-alternCHARACTERNome usuário alternativoNãoNão se aplica
mo-codigoINTEGERCódigo MoedaSimNão se aplica
desc-moedaCHARACTERDescrição MoedaSimNão se aplica
cod-rejeicaoINTEGERCódigo RejeiçãoNãoNão se aplica
desc-rejeicaoCHARACTERDescrição RejeiçãoNãoNão se aplica
aprov-autoLOGICALAprovação automáticaSimNão se aplica
desc-situacaoCHARACTERDescrição situaçãoSImNão se aplica
ind-situacaoINTEGERSituaçãoSimNão se aplica
chave-docCHARACTERChave documentoSimNão se aplica
narrativa-aprCHARACTERNarrativa aprovaçãoNãoNão se aplica
narrativa-rejCHARACTERNarrativa rejeiçãoNãoNão se aplica

tt-chave

Entrada/Saída

Temp-table com a chave formatada do documento

Saída

Atributo

Tipo

Descrição

Obrigatório

Evolução

cod-tip-doc

INTEGER

Código do Documento

Sim

Não se aplica

posicao-ini

INTEGER

Posição inicial

Sim

Não se aplica

posicao-fimINTEGERPosição finalSimNão se aplica
desc-campoCHARACTERDescrição campo chaveSimNão se aplica
char-1CHARACTERCampo character livre 1NãoNão se aplica
char-2CHARACTERCampo character livre 2NãoNão se aplica
char-3CHARACTERCampo character livre 3NãoNão se aplica
char-4CHARACTERCampo character livre 4NãoNão se aplica
char-5CHARACTERCampo character livre 5NãoNão se aplica
dec-1DECIMALCampo decimal livre 1NãoNão se aplica
dec-2DECIMALCampo decimal livre 2NãoNão se aplica
dec-3DECIMALCampo decimal livre 3NãoNão se aplica
dec-4DECIMALCampo decimal livre 4NãoNão se aplica
dec-5DECIMALCampo decimal livre 5NãoNão se aplica
int-1INTEGERCampo integer livre 1NãoNão se aplica
int-2INTEGERCampo integer livre 2NãoNão se aplica
int-3INTEGERCampo integer livre 3NãoNão se aplica
int-4INTEGERCampo integer livre 4NãoNão se aplica
int-5INTEGERCampo integer livre 5NãoNão se aplica
log-1LOGICALCampo logical livre 1NãoNão se aplica
log-2LOGICALCampo logical livre 2NãoNão se aplica
log-3LOGICALCampo logical livre 3NãoNão se aplica
log-4LOGICALCampo logical livre 4NãoNão se aplica
log-5LOGICALCampo logical livre 5NãoNão se aplica
data-1DATECampo data livre 1NãoNão se aplica
data-2DATECampo data livre 2NãoNão se aplica
data-3DATECampo data livre 3NãoNão se aplica
data-4DATECampo data livre 4NãoNão se aplica
data-5DATECampo data livre 5NãoNão se aplica
ep-codigoCHARACTERCódigo da empresaSimNão se aplica
valorCHARACTERValor da chaveSimNão se aplica

getUsuarInformation

Requisito

Nenhum.

Sintaxe

RUN  getUsuarInformation IN h-handle(OUTPUT TABLE tt-info-usuar).

Descrição

Retorna informações padrões do usuário logado.

Obs: Para acessar este método via REST usar a procedure REST_GET_getUsuarInformation.

Retorno

tt-info-usuar: temp-table com as informações do usuário

tt-info-usuar

Entrada/Saída

Temp-table com o histórico de aprovações do documento.

Saída

Atributo

Tipo

Descrição

Obrigatório

Evolução

cod-usuar

CHARACTER

Código do usuário

Sim

Não se aplica

usuar-mestreLOGICALIndica se o usuário é mestreSimNão se aplica
idi-ordenacao-portalINTEGEROrdenação padrãoSimNão se aplica
log-pendcia-todas-empresLOGICALIndica que o usuário visualiza todas as pendênciasSimNão se aplica
log-visualiza-detalhe-listagemLOGICALIndica se deverá ser exibido o detalhe da pendência na listagem de pendênciasSimNão se aplica
log-visualiza-contador-pendenciaLOGICALIndica se deverá ser exibido o contador de pendênciasSimNão se aplica
idi-visualizacao-padraoINTEGERVisualização padrãoSimNão se aplica
ep-codigoCHARACTERCódigo da empresa logadaSimNão se aplica
ep-codigo descCHARACTERRazão social da empresa logadaSimNão se aplica
log-aprovac-unica-pendciaLOGICALIndica que o botão de aprovação individual não considera os registros selecionadosSimNão se aplica