Documento de API

Objetivo

Retornar a unidade de negócio conforme o código de estabelecimento informado ao programa.

Funcionamento

Para executar o Programa API(utilizar o nome externo), deve ser passado para o programa:

• código do Estabelecimento do tipo caracter com “x(3)” (caso não tenha o código do Estabelecimento traduzido, deve ser passado valor caracter branco);
• código do Estabelecimento externo do tipo caracter com “x(8)” (somente para quando não tiver o código do estabelecimento traduzido, senão é passado valor caracter branco);
• código da matriz de tradução da Unidade Organizacional do tipo caracter com “x(8)” (só deverá ser informado quando houver a necessidade de tradução do Estabelecimento Externo);
• data de referência do tipo data, e  da matriz de  Espécie com valor caracter com “x(3)”;

Onde será retornado:

• código de retorno do tipo caracter com “x(40)”;
• código da Unidade de Negócio do tipo caracter com “x(3)”

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 prgint/ufn/ufn707za.py (Input 1,

                            Input c-cod-estab,

                            Input c-cod-estab-ext,

                            Input c-matr-trad,

                            Input d-dat-refer,

                            Output c-retorno,

                            Output c-cod-unid-negoc).

Parâmetros Entrada/Saída da API

Os parâmetros de entrada e saída são:

p_num_vers_integr_api.........: será utilizado para determinar se o programa que está chamando está íntegro com as definições correntes da API;

p_cod_estab...........................: receberá o código do estabelecimento que já está traduzido e que será utilizada para buscar a Unidade de Negócio;

p_cod_estab_ext: receberá o código do estabelecimento a ser traduzido e será feita a tradução da mesma;

p_cod_matriz_trad_org_ext..: receberá o código da matriz de tradução da Unidade Organizacional para poder fazer a tradução do código do estabelecimento. Este campo só deverá ser informado quando o p_cod_estab_ext estiver preenchido;

p_dat_refer..............................: receberá a data de referência para efetuar a busca da Unidade de Negócio conforme o código do estabelecimento;

p_cod_return...........................: caso ocorra erro será retornado o código e a descrição desse erro, caso contrário será retornado “OK”;

p_cod_unid_negoc.................: retornará o código da Unidade de Negócio caso tenha sido encontrado senão retornará vazio.