Entendimento: Inclusão do endereço residencial do cliente.
Endpoint:
POST> {{url_ws}}/tfs-basico-service/rest/cadastro/endereco |
---|
Exemplo Body (postman Collection):
{ |
---|
Campos identificados no Body de Exemplo:
Campo | Tipo | Tamanho | Obrigatório | Observação |
codigoCliente | NUMERICO | 8 | SIM | Código Cliente retornado após incluir pessoa |
codigoUnidade | NUMERICO | 10 | SIM | Código da unidade *poderá chamar a consulta item Código Unidade abaixo |
siglaTipoEndereco | CHAR | 15 | SIM | Tipo do endereço. Ex: RESIDENCIAL *lista conforme consulta item Tipo Endereço |
siglaUf | CHAR | 2 | NÃO | Unidade da Federação do endereço. *poderá chamar a consulta da UF item Siga UF **pode-se usar a busca por CEP, retorna informações UF, Cidade, Logradouro, Bairro, Tipo Endereço, item Busca Endereço por CEP |
nomeCidade | CHAR | 72 | NÃO | Cidade do Endereço |
nomeBairro | CHAR | 72 | NÃO | Bairro do Endereço |
codigoCep | NUMERO | 8 | SIM | CEP do Endereço |
nomeLogradouro | CHAR | 72 | NÃO | Logradouro do Endereço |
numeroEndereco | NUMERO | 10 | NÃO | Número do endereço |
descricaoComplementoEndereco | CHAR | 10 | NÃO | Complemento do endereço |
numeroDdd | NUMERO | 4 | NÃO | DDD do Telefone |
numeroTelefone | NUMERO | 10 | NÃO | Número do Telefone |
numeroDddCelular | NUMERO | 4 | NÃO | DDD do Celular |
numeroCelular | NUMERO | 10 | NÃO | Número do Celular |
enderecoEmail | CHAR | 70 | NÃO | Endereço de e-mail do cliente |
siglaTipoLogradouro | CHAR | 15 | NÃO | Tipo do endereço. Ex: RUA *domínios item Tipo Logradouro |
telefoneCompleto | NUMERO | 12 | NÃO | DDD + Número do Telefone |
idenTipoEndereco | BOOLEAN | true/false | SIM | Identifica se é principal ou não. *Regra: caso endereço RESIDENCIAL for true como principal, CORRESPONDENCIA será false |
Itens Domínios/Tabelas
- Código Unidade
GET> {{url}}/tfs-basico-service/rest/cadastro/unidadeFisica |
---|
- Tipo Endereço
GET> {{url_ws}}/tfs-basico-service/rest/cadastro/tipoEndereco |
---|
- Tipo Logradouro
GET> {{url_ws}}/tfs-basico-service/rest/cadastro/tipoLogradouro |
---|
Exemplo buscar passando nome:
{{url_ws}}/tfs-basico-service/rest/cadastro/tipoLogradouro?nome=AVENIDA&Page=1&size=50
GET> {{url_ws}}/tfs-basico-service/rest/cadastro/tipoLogradouro?nome=AVENIDA&Page=1&size=50 |
---|
- Sigla Uf
Valores aceitos:
"AC" or "AL" or "AM" or "AP" or "BA" or "CE" or "DF" or "ES" or "GO" or "MA" or "MG" or "MS" or "MT" or "PA" or "PB" or "PE" or "PI" or "PR" or "RJ" or "RN" or "RO" or "RR" or "RS" or "SC" or "SE" or "SP" or "TO" |
---|
- Buscar Endereço por CEP
GET> {{url_ws}}/tfs-basico-service/rest/parametros/v1/cep/90690300
GET> {{url_ws}}/tfs-basico-service/rest/parametros/v1/cep/90690300 |
---|
*Para obter as informações como UF, Cidade, Bairro, Logradouro,
Se retorno busca acima o campo "siglaTabelaCep": "t400clog " chamar ceplogradouro,
Se for "siglaTabelaCep": "t400clog " chamar cepespecial
GET> {{url_ws}}/tfs-basico-service/rest/parametros/v1/ceplogradouro?codigoCep=90690300
GET> {{url_ws}}/tfs-basico-service/rest/parametros/v1/ceplogradouro?codigoCep=90690300 |
---|
Ou
GET> {{url_ws}}/tfs-basico-service/rest/parametros/v1/cepespecial?codigoCep=90619900 |
---|