Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicocrmapi\apiEndereco.p

 

Objetivo

Consultar eendereço e cep.

 

Tabelas Temporárias

Atributos das tabelas temporárias de entrada e saída:

tt-

 

Atributo

Tipo

Formato

        Descrição

Obr.

 

 

 

 

 

 

tt

Tabela definida conforme tabela <>, porém com as diferenças abaixo.

Atributo

Tipo

Formato

        Descrição

Obr.

 

 

 

 

 

 

Parâmetros de input e output da api

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

 

 

 

 

 

 

 

 

Métodos 

 

Métodos básicos

  

Método: carregaRelacionamCep

Descrição: retorna dados do endereço apartir do cep.          

Requisitos: nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

i-num_cep

Int

 

X

 

 

Cep

c-num_cep

Char

 

 

X

 

Cep

i-PaisEnder

Char

 

 

X

 

País

i-BairroEnder

Char

 

 

X

 

Bairro

i-CidadeEnder

Char

 

 

X

 

Cidade

i-UnidFederEnder

Char

 

 

X

 

UF

c-nomLogradEnder

Char

 

 

X

 

logradouro

  

Método: buscaPorCodCep

Descrição: retorna dados do endereço apartir do cep.           

Requisitos: nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-num_cep

Char

 

X

 

 

Cep

i-cep

Int

 

 

X

 

Id do cep

i-count

Int

 

 

X

 

Qtd de ceps identicos

  

Método: habilitaBotaoExcluir

Descrição: verifica se é permitido excluir cep.           

Requisitos: nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

numId

Int

 

X

 

 

Endereço

l-integrad_erp

Log

 

 

X

 

Permite excluir