Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | cdp/ccapi347.p |
Considerações Gerais
Objetivo
Fazer a chamada do portal do Clicbusiness para o encerramento das cotações ou para informar que o termo de aceite, foi aceito.
Funcionamento
A execução da API na forma persistente, é passado como parâmetro a variável p-tipo-procedure, que pode conter os valores “encerrar” para encerrar uma cotação ou “termoAceite” para o envio do termo de aceite do Clicbusiness.
A sintaxe para executar a API em modo persistente é:
run ccp/ccapi347.p persistent set h-handle (input p-tipo-procedure).
Atributo Tipo Descrição p-tipo-procedure Character Informa qual tipo de operação será realizado. Para encerramento enviar “encerrar” e para Termo de aceite enviar “termoAceite” |
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:
tt-ids-ordens-encerrar | Entrada/Saída | ||||
Temp-table com as ordens para serem encerradas | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
nr-ordem-processo | INTEGER |
| Número de uma ordem de compra ou número de um processo de compra | Sim | Não |
tt-error | Entrada/Saída | ||||
Temp-table com os erros retornados do Clicbusiness | Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
seq | INTEGER |
| Sequência das mensagens na temp-table | Sim | Não |
msg | CHARACTER |
| Mensagem de erro que deve retornar para o programa chamador | Sim | Não |
Método Básico
Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
chamadaURLEncerrarCotacao | ||
Requisito | Existência da cotação no sistema do Clicbusiness | |
Sintaxe | Run chamadaURLEncerrarCotacao in handle (input table tt-ids-ordens-encerrar, output table tt-error, c-tipo, i-ordem-processo). | |
Descrição | Encerrar cotações de ordens no Clicbusiness | |
Parâmetros | Descrição | |
tt-ids-ordens-encerrar | Temp-table com as ordens para encerrar | |
tt-error | Temp-table com os erros retornados do Clicbusiness | |
c-tipo | Se está sendo executado ordem ou processo. Enviar “proc” para processo e “ord” para ordem. | |
i-ordem-processo | O número da ordem ou do processo que está sendo executado. | |
Retorno | A API/ irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-error e gravados no log. As mensagens possíveis para este método são:
| |
chamadaURLTermoAceite | ||
Requisito | nenhum | |
Sintaxe | Run chamadaURLTermoAceite in handle (output table tt-table error). | |
Descrição | Procedure para o envio de dados do termo de consciência de utilização do Clicbusiness | |
Parâmetros | Descrição | |
tt-error | Temp-table com os erros retornados do Clicbusiness | |
Retorno | A API/ irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-error e gravados no log. As mensagens possíveis para este método são:
| |
Import HTML Content
Visão Geral
Conteúdo das Ferramentas