Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | fch/fchdis/fchdis0029c.p |
Considerações Gerais
Objetivo
Validar e retornar dados da integração com o EAI2 para os processos de distribuição.
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 fch/fchdis/fchdis0029c.p |
A sintaxe para executar a API em modo persistente é:
run fch/fchdis/fchdis0029c.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 Básico
Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
returnParamPed | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Retornar os dados da parametrização padrão da distribuição para incluir no cabeçalho da messagem. | |
Parâmetros | Descrição | |
pusername | Usuário. | |
ppassword | Senha. | |
pcompanyId | Empresa. | |
puserId1 | Código do usuário ems2. | |
Retorno | pusername (saida). ppassword (saida). pcompanyId (saida). puserId1 (saida). |
returnParamMessage | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Retornar os dados do ems2 para incluir no cabeçalho da messagem. | |
Parâmetros | Descrição | |
cEmp | Empresa. | |
cUser | Usuário . | |
cEstab | Estabelecimento . | |
Retorno | cEmp (saida). cUser (saida). cEstab (saida). |
verificaClienteInativo | ||
Requisito | Nenhum. | |
Sintaxe | - | |
Descrição | Retornar a situação da cliente (ativo ou inativo). | |
Parâmetros | Descrição | |
pEmitente | Cliente. | |
pcSituacao | Situação. | |
Retorno | cEmp (saida). cUser (saida). cEstab (saida). |