especificação de serviço gerar cartão pessoa...
TRANSCRIPT
Especificação de Serviço –
Gerar Cartão Pessoa Física Versão do Documento: 0.1
Última Atualização: 13/09/2018
HISTÓRICO DE REVISÕES
Fluxo do Serviço
Data Versão Detalhamento Autor 13/09/2018 0.1 Criação do documento. Vinícius Joaquim
Descrição dos Campos
Id_Campo Campo Ocorrência Código Descrição
1 Sexo 1 M Masculino
1 Sexo 2 F Feminino
1 Sexo 3 I Indefinido
2 Estado Civil 1 1 Solteiro
2 Estado Civil 2 2 Casado
2 Estado Civil 3 3 Desquitado
2 Estado Civil 4 4 Viúvo
2 Estado Civil 5 5 Divorciado
2 Estado Civil 6 6 Companheiro
2 Estado Civil 7 7 Separado
15 Tipo de Telefone 1 1 Residencial
15 Tipo de Telefone 2 2 Contato
16 Nacionalidade 1 1 Brasileira
16 Nacionalidade 2 2 Estrangeira
22 Profissao 1 1 ADMINISTRADOR DE EMPRESAS
22 Profissao 2 2 ADVOGADO
22 Profissao 3 3 AEROVIÁRIOS, EMPREGADOS DE AEROPORTO ETC
22 Profissao 4 4 AGENTE DE VIAGEM, GUIA E OUTROS DO SETOR
22 Profissao 5 5 TRABALHADOR AGRÍCOLA
22 Profissao 6 6 AGRÔNOMO
22 Profissao 7 7 APOSENTADOS EM GERAL
22 Profissao 8 8 ARQUITETO
22 Profissao 9 9 ASSIS SOCIAL
22 Profissao 10 10 CARGO DIREÇÃO E ASSESSORAMENTO SUPERIOR
22 Profissao 11 11 AUTÔNOMO
22 Profissao 12 12 CRIAÇÃO DE PEQUENOS ANIMAIS, GRANJAS, ETC.
22 Profissao 13 13 BANCÁRIO, ECONOMIÁRIO
22 Profissao 14 14 EMPRESÁRIO
22 Profissao 15 15 BIBLIOTECÁRIO, ARQUIVISTA, MUSEÓLOGO,
ARQUEÓLOGO
22 Profissao 16 16 BIÓLOGO, BIOMÉDICO
22 Profissao 17 17 CABELEIREIRO, BARBEIRO, MANICURE, PEDICURE,
MAQUILADOR, MASSAGISTA
22 Profissao 18 18 CARPINTEIRO, MARCENEIRO
22 Profissao 19 19 COMERCIÁRIOS EM GERAL
22 Profissao 20 20 PROPRIETÁRIO DE ESTABELECIMENTO COMERCIAL
22 Profissao 21 21 PROPRIETÁRIO DE PEQUENAS E MICROEMPRESAS,
EMPREITEIRO, CONSTRUTOR
22 Profissao 22 22 CONTADOR
22 Profissao 23 23 CORRETOR DE IMÓVEIS, SEGUROS, TÍTULOS E
VALORES, BENS, DETETIVE PARTICULAR
22 Profissao 24 24 ODONTÓLOGO
22 Profissao 25 25 DESENHISTA TÉCNICO, PROJETISTA ETC
22 Profissao 26 26 ECONOMISTA
22 Profissao 27 27 DIRETOR, ORIENTADOR PEDAGÓGICO, SECRETARIA DE
ESCOLA, ETC.
22 Profissao 28 28 ELETRICISTA DE MANUTENÇÃO DE VEÍCULOS,
MAQUINAS E APARELHOS
22 Profissao 30 30 ENFERMEIRO, NUTRICIONISTA
22 Profissao 31 31 ENGENHEIRO
22 Profissao 32 32 PROFISSIONAIS DE LETRAS E ARTES
22 Profissao 33 33 ESCULTOR, PINTOR, ARTISTA PLÁSTICO E
ASSEMELHADOS
22 Profissao 34 34 DESENHISTA COMERCIAL
22 Profissao 35 35 ESTAGIÁRIO, BOLSISTA, ESTUDANTE, TRAINEES ETC
22 Profissao 36 36 FARMACÊUTICO
22 Profissao 37 37 FERRAMENTEIRO
22 Profissao 38 38 FÍSICO
22 Profissao 39 39 FISIOTERAPEUTA, TERAPEUTA NUTRICIONAL
22 Profissao 40 40 SERVIDOR PUBLICO ESTADUAL
22 Profissao 41 41 SERVIDOR PUBLICO FEDERAL
22 Profissao 42 42 SERVIDOR PUBLICO MUNICIPAL
22 Profissao 43 43 GEÓGRAFO
22 Profissao 44 44 SERRALHEIRO, IMPRESSOR, LINOTIPISTA, BLOQUISTA,
OPER. OFFSET, OPER. ROTATIVA
22 Profissao 47 47 PROPRIETÁRIO DE ESTABELECIMENTO INDUSTRIAL
22 Profissao 49 49 OURIVES, JOALHEIRO
22 Profissao 50 50 JORNALEIRO, FLORISTA
22 Profissao 51 51 JORNALISTA
22 Profissao 52 52 AUXILIAR LABORATÓRIO, SAPATEIRO, CHAVEIRO,
RELOJOEIRO, JARDINEIRO
22 Profissao 53 53 MECÂNICO DE MANUTENÇÃO DE VEÍCULOS
AUTOMOTORES
22 Profissao 54 54 MEDICO
22 Profissao 55 55 METALÚRGICO
22 Profissao 56 56 FUNCIONÁRIO DE EMPRESAS PUBLICAS
22 Profissao 57 57 MOTORISTA AUTÔNOMO, TAXISTA
22 Profissao 58 58 MUSICO
22 Profissao 60 60
PEDREIRO, ENCANADOR, AZULEJISTA, IMPERMEABILIZADOR, COLOCADOR
(CARPETES,SINTECO)
22 Profissao 61 61 PENSIONISTA
22 Profissao 62 62 TRABALHADOR DA PESCA
22 Profissao 63 63 PINTOR DE PAREDES, GESSISTA
22 Profissao 64 64 MINISTRO, GOVERNADOR, PREFEITO, SECRETÁRIO DE
ESTADO/MUNICÍPIO
22 Profissao 65 65 ESTIVADOR, CARREGADOR, EMBALADOR
22 Profissao 66 66 PSICÓLOGO
22 Profissao 67 67 PROFESSOR DE ENSINO 1º E 2º GRAUS
22 Profissao 68 68 PROMOTOR DE VENDAS E OUTROS
22 Profissao 69 69 PUBLICITÁRIO (CONTATO, DIRETOR DE ARTE, REDATOR
ETC)
22 Profissao 70 70 QUÍMICO
22 Profissao 71 71 LOCUTOR, RADIALISTA, COMENTARISTA DE RADIO E TV
22 Profissao 74 74 REPRESENTANTE COMERCIAL, CAIXEIRO VIAJANTE
22 Profissao 75 75 NÃO CLASSIFICADO
22 Profissao 76 76 OUTROS GRUPO 15
22 Profissao 77 77 CALCETEIRO, CANTEIRO, MANOBRISTA, VIDRACEIRO
22 Profissao 78 78 MODELO DE MODAS
22 Profissao 79 79 FISCAL DE TRAFEGO E OUTROS
22 Profissao 80 80 VIGIA, VIGILANTE, GUARDA, SEGURANÇA, BOMBEIRO
22 Profissao 81 81 OUTROS GRUPO 12
22 Profissao 84 84 VETERINÁRIO, ZOOTÉCNICO
22 Profissao 85 85 GEÓLOGO
22 Profissao 86 86 OUTROS GRUPO 13
22 Profissao 87 87 EMPREGADOS DOMÉSTICOS EM GERAL
22 Profissao 88 88 SACERDOTE, PADRE, PASTOR
22 Profissao 89 89 SOCIÓLOGO
22 Profissao 90 90 ATUARIO, MATEMÁTICO
22 Profissao 91 91 ATLETA PROFISSIONAL E TÉCNICO EM DESPORTOS
22 Profissao 92 92 MINISTRO DE TRIBUNAL SUPERIOR, JUIZ,
DESEMBARGADOR
22 Profissao 93 93 SECRETARIA, ESTENOGRAFA, DATILOGRAFA,
RECEPCIONISTA, TELEFONISTA, OPER DE TMK
22 Profissao 94 94 AUX DE ESCRIT, VENDAS, ADMINIST., ALMOXARIF,
ASSISTENTE, CALCULISTA, BILHETEIRO
22 Profissao 95 95 DIGITADOR
22 Profissao 96 96 OUTROS TÉCNICOS DE NIVEL MEDIO
22 Profissao 97 97 PRAÇA (SOLDADO / CABO / SARGENTO / SUBTENENTE)
DA PM
22 Profissao 98 98 TRAB.CONTÁBIL / CAIXAS E ASSEMELHADOS
22 Profissao 100 100 EMPREGADO DE RESTAURANTE, BUFFET,
LANCHONETE, PADARIA E REFEIÇÕES INDUSTRIAIS
22 Profissao 101 101 COSTUREIRA / BORDADEIRA / TAPECEIRA /
OVERLOQUISTA / PESPONTADEIRA
22 Profissao 102 102 ATENDENTE DE ENFERMAGEM / AUXILIAR DE
ENFERMAGEM / AUX CRECHE
22 Profissao 103 103 VIVE DE RENDA /ALUGUEL / SÓCIO / PROPRIETÁRIO
22 Profissao 104 104 DONA DE CASA / PRENDA DOMÉSTICAS
22 Profissao 105 105 OPERADOR DE MÁQUINAS DE PRODUÇÃO EM GERAL
22 Profissao 106 106 CHEFE INTERM/ENCARREGADO SERV/ SUPERV /CHEFES
DE SEÇÃO
22 Profissao 107 107 PORTEIRO / ASCENSORISTA / GARAGISTA / FAXINEIRO
22 Profissao 108 108 AUX ESCRITÓRIO/ AUX ALMOXARIFADO / CONFERENTE
/ BILHETEIRO
22 Profissao 109 109 EM BRANCO
22 Profissao 110 110 GERENTE
22 Profissao 111 111 VENDEDOR
AUTÔNOMO/AMBULANTE/CAMELÔS/SACOLEIRAS
22 Profissao 112 112 VENDEDOR COMÉRCIO VAREJISTA E ATACADISTA
22 Profissao 113 113 MOTORISTA EMPREGADO DO TRANSPORTE DE
PASSAGEIROS
22 Profissao 114 114 AUXILIAR DE COZINHA/COSTURA/LIMPEZA/COPA
22 Profissao 115 115 AJUD.GERAL/AUX.SERV.GERAIS/AJ DE
PEDREIRO/SERVENTE/AJ DE MOTORISTA
22 Profissao 116 116 OFFICE BOY/CONTÍNUOS/MOTOCICLISTA/CICLISTA
23 Tipos de Origem
Comercial 1 A Coletivo
23 Tipos de Origem
Comercial 2 B Individual
33 Natureza da Ocupacao 1 1 Aposentado
33 Natureza da Ocupacao 2 2 Empregados
33 Natureza da Ocupacao 3 3 Profissionais Liberais
33 Natureza da Ocupacao 4 4 Autonomo
33 Natureza da Ocupacao 5 5 Outros
Gerar Cartão Pessoa Física
Gerar Cartão Pessoa Física é responsável por gerar um cartão para pessoa física, usando os
seguintes parâmetros:
Parâmetros Descrição Tipo Aceita
Nulo
nome Nome do Cliente string Não
nomeMae Nome da Mãe do Cliente string Não dataNascimento Data de Nascimento string Não
sexo Sexo do Cliente string Não cpf CPF do Cliente string Não
numeroIdentidade RG do Cliente string Não orgaoExpedidorIdentidade Orgão Expedidor do RG string Não
unidadeFederativaIdentidade UF do RG string Não dataEmissaoIdentidade Data de Emissão do RG string Não
idEstadoCivil Id do Estado Civil Integer Não
idProfissao Id da Profissão string Não
idNaturezaOcupacao Id da Ocupação Integer Não
idNacionalidade Id da Nacionalidade Integer Não
idOrigemComercial Id de Origem Comercial Integer Não
idProduto Id do Produto Integer Não
numeroAgencia Número da Agência Integer Não
numeroContaCorrente Número da Conta Corrente string Não
email E-mail do Cliente string Não
diaVencimento Dia do Vencimento do Cartão Integer Não
nomeImpresso string Não
nomeEmpresa Nome da Empresa string Não
valorRenda Valor da Renda do Cliente Integer Não
canalEntrada string Não
valorPontuacao Integer Não
id_tipo_plastico Id do Tipo de Plástico Integer Não
idTipoTelefone Id do Tipo de Telefone Integer Não
ddd DDD string Não
telefone Telefone do Cliente string Não
ramal Ramal string Não
idTipoEndereco Id do Tipo de Endereço Integer Não
cep CEP do Cliente string Não
logradouro Logradouro string Não
numero Número da Residência Integer Não
complemento Complemento string Não
pontoReferencia Ponto de Referência string Não
bairro Bairro string Não
cidade Cidade string Não
uf UF do Endereço string Não
pais País string Não
enderecoCorrespondencia Endereço para correspondência bool Não
limiteGlobal Limite Global Integer Não
limiteMaximo Limite Máximo Integer Não
limiteParcelas Limite de Parcelas Integer Não
limiteConsignado Limite Consignado Integer Não
nomeReferencia1 Nome Referência 1 string Não
enderecoReferencia1 Endereço Referência 1 string Não
nomeReferencia2 Nome Referência 2 string Não
enderecoReferencia2 Endereço Referência 2 string Não
Resource URL
https://caradhras.io/api/v1/gerar-cartao-pf
Exemplo de Requisição
{
"nome": "xxxxxxxxxxxxx",
"nomeMae": "xxxxxxxxxxxxx",
"dataNascimento": "xxxxxxxxxxxxx",
"sexo": "xxxxxxxxxxxxx",
"cpf": "xxxxxxxxxxxxx",
"numeroIdentidade": "xxxxxxxxxxxxx",
"orgaoExpedidorIdentidade": "xxxxxxxxxxxxx",
"unidadeFederativaIdentidade": "xxxxxxxxxxxxx",
"dataEmissaoIdentidade": "xxxxxxxxxxxxx",
"idEstadoCivil": 0,
"idProfissao": "xxxxxxxxxxxxx",
"idNaturezaOcupacao": 0,
"idNacionalidade": 0,
"idOrigemComercial": 0,
"idProduto": 0,
"numeroAgencia": 0,
"numeroContaCorrente": "xxxxxxxxxxxxx",
"email": "xxxxxxxxxxxxx",
"diaVencimento": 0,
"nomeImpresso": "xxxxxxxxxxxxx",
"nomeEmpresa": "xxxxxxxxxxxxx",
"valorRenda": 0,
"canalEntrada": "xxxxxxxxxxxxx",
"valorPontuacao": 0,
"id_tipo_plastico": 0
"telefones": [
{
"idTipoTelefone": 0,
"ddd": "xxxxxxxxxxxxx",
"telefone": "xxxxxxxxxxxxx",
"ramal": "xxxxxxxxxxxxx"
}
],
"enderecos": [
{
"idTipoEndereco": 0,
"cep": "xxxxxxxxxxxxx",
"logradouro": "xxxxxxxxxxxxx",
"numero": 0,
"complemento": "xxxxxxxxxxxxx",
"pontoReferencia": "xxxxxxxxxxxxx",
"bairro": "xxxxxxxxxxxxx",
"cidade": "xxxxxxxxxxxxx",
"uf": "xxxxxxxxxxxxx",
"pais": "xxxxxxxxxxxxx",
"enderecoCorrespondencia": false
}
],
"limiteGlobal": 0,
"limiteMaximo": 0,
"limiteParcelas": 0,
"limiteConsignado": 0,
"nomeReferencia1": "xxxxxxxxxxxxx",
"enderecoReferencia1": "xxxxxxxxxxxxx",
"nomeReferencia2": "xxxxxxxxxxxxx",
"enderecoReferencia2": "xxxxxxxxxxxxx"
}
Exemplo de Requisição
Inserir endereço do swagger
Exemplo de Resposta
Inserir endereço do swagger
Exemplo de Resposta
{
"nome": "xxxxxxxxxxxxx",
"nomeMae": "xxxxxxxxxxxxx",
"dataNascimento": "xxxxxxxxxxxxx",
"sexo": "xxxxxxxxxxxxx",
"cpf": "xxxxxxxxxxxxx",
"numeroIdentidade": "xxxxxxxxxxxxx",
"orgaoExpedidorIdentidade": "xxxxxxxxxxxxx",
"unidadeFederativaIdentidade": "xxxxxxxxxxxxx",
"dataEmissaoIdentidade": "xxxxxxxxxxxxx",
"idEstadoCivil": 0,
"idProfissao": "xxxxxxxxxxxxx",
"idNaturezaOcupacao": 0,
"idNacionalidade": 0,
"idOrigemComercial": 0,
"idProduto": 0,
"numeroAgencia": 0,
"numeroContaCorrente": "xxxxxxxxxxxxx",
"email": "xxxxxxxxxxxxx",
"diaVencimento": 0,
"nomeImpresso": "xxxxxxxxxxxxx",
"nomeEmpresa": "xxxxxxxxxxxxx",
"valorRenda": 0,
"canalEntrada": "xxxxxxxxxxxxx",
"valorPontuacao": 0,
"id_tipo_plastico": 0
"telefones": [
{
"idTipoTelefone": 0,
"ddd": "xxxxxxxxxxxxx",
"telefone": "xxxxxxxxxxxxx",
"ramal": "xxxxxxxxxxxxx"
}
],
"enderecos": [
{
"idTipoEndereco": 0,
"cep": "xxxxxxxxxxxxx",
"logradouro": "xxxxxxxxxxxxx",
"numero": 0,
"complemento": "xxxxxxxxxxxxx",
"pontoReferencia": "xxxxxxxxxxxxx",
"bairro": "xxxxxxxxxxxxx",
"cidade": "xxxxxxxxxxxxx",
"uf": "xxxxxxxxxxxxx",
"pais": "xxxxxxxxxxxxx",
"enderecoCorrespondencia": false
}
],
"limiteGlobal": 0,
"limiteMaximo": 0,
"limiteParcelas": 0,
"limiteConsignado": 0,
"nomeReferencia1": "xxxxxxxxxxxxx",
"enderecoReferencia1": "xxxxxxxxxxxxx",
"nomeReferencia2": "xxxxxxxxxxxxx",
"enderecoReferencia2": "xxxxxxxxxxxxx"
}