Cliente | Fiadores/Responsáveis
Este artigo documenta o processo para inserir, editar e deletar um fiador de um cliente.
Recurso responsável pelas informações dos fiadores de um cliente.
Inserir fiador
Insere um fiador de um cliente.
| Requisição | |
| Método | POST |
| URL | /api/v1/clientes/{id}/fiadores |
| Formato do conteúdo | application/json |
| Parâmetro de URL | |
id |
Código identificador do cliente |
| Exemplo de uso | |
/api/v1/clientes/12345/fiadores |
|
|
Estrutura de dados da requisição |
||||
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
nome |
String | 60 | Não |
Nome do fiador |
fiador |
Integer | 1 | Sim |
Fiador SIM NAO |
responsavel |
Integer | 1 | Sim |
Responsável SIM NAO |
cpf |
String | 14 | Não |
CPF do fiador |
rg |
String | 20 | Não |
RG do fiador |
telefone |
String | 20 | Não |
Telefone do fiador |
celular |
String | 20 | Não |
Celular do fiador |
endereco |
String | 60 | Não |
Endereço do fiador |
numero |
String | 10 | Não |
Número da residência |
bairro |
String | 30 | Não |
Bairro da residência |
municipio |
Object | - | Não |
Município |
municipio.id |
Integer | - | Sim | Código do município |
cep |
String | 9 | Não |
Cep do município |
email |
String | 100 | Não |
E-mail do fiador |
estadoCivil |
String | 15 | Sim |
Estado civil SOLTEIRO CASADO DIVORCIADO VIUVO |
nascimento |
Date | - | Não |
Data de nascimento no formato AAAA-MM-DD |
admissao |
Date | - | Não |
Data de admissão no formato AAAA-MM-DD |
ocupacao |
Object | - | Não |
Ocupação |
ocupacao.id |
Integer | _ | Sim |
Código da ocupação |
Exemplo da requisição
{
"nome": "Teste",
"fiador": "SIM",
"responsavel": "NAO",
"cpf": "000.000.000-77",
"rg": "0.000.000",
"telefone": "0000-0000",
"celular": "(49) 00000-0000",
"endereco": "Rua teste",
"numero": "10",
"bairro": "teste",
"municipio": {
"id": 1
},
"cep": "89874-000",
"email": "teste@teste.com.br",
"estadoCivil": "SOLTEIRO",
"nascimento": "1999-10-04",
"admissao": "2005-09-10",
"ocupacao": {
"id": 1
}
}Resposta
A API retornará o código identificador do fiador inserido.
|
Estrutura de dados do resposta |
||||
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
id |
Integer | - | Sim | Código identificador do fiador |
Exemplo de resposta
{
"id": 1
}Editar fiador
Atualiza o fiador de um cliente.
| Requisição | |
| Método | PUT |
| URL | /api/v1/clientes/{id}/fiadores/{fiadorId} |
| Formato do conteúdo | application/json |
| Parâmetro de URL | |
id |
Código identificador do cliente |
fiadorId |
Código identificador do fiador |
| Exemplo de uso | |
/api/v1/clientes/12345/fiadores/1 |
|
|
Estrutura de dados da requisição |
||||
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
nome |
String | 60 | Não |
Nome do fiador |
fiador |
Integer | 1 | Sim |
Fiador SIM NAO |
responsavel |
Integer | 1 | Sim |
Responsável SIM NAO |
cpf |
String | 14 | Não |
CPF do fiador |
rg |
String | 20 | Não |
RG do fiador |
telefone |
String | 20 | Não |
Telefone do fiador |
celular |
String | 20 | Não |
Celular do fiador |
endereco |
String | 60 | Não |
Endereço do fiador |
numero |
String | 10 | Não |
Número da residência |
bairro |
String | 30 | Não |
Bairro da residência |
municipio |
Object | - | Não |
Município |
municipio.id |
Integer | - | Sim | Código do município |
cep |
String | 9 | Não |
Cep do município |
email |
String | 100 | Não |
E-mail do fiador |
estadoCivil |
String | 15 | Sim |
Estado civil SOLTEIRO CASADO DIVORCIADO VIUVO |
nascimento |
Date | - | Não |
Data de nascimento no formato AAAA-MM-DD |
admissao |
Date | - | Não |
Data de admissão no formato AAAA-MM-DD |
ocupacao |
Object | - | Não |
Ocupação |
ocupacao.id |
Integer | _ | Sim |
Código da ocupação |
Exemplo da requisição
{
"nome": "Teste",
"fiador": "SIM",
"responsavel": "NAO",
"cpf": "000.000.000-77",
"rg": "0.000.000",
"telefone": "0000-0000",
"celular": "(49) 00000-0000",
"endereco": "Rua teste",
"numero": "10",
"bairro": "teste",
"municipio": {
"id": 1
},
"cep": "89874-000",
"email": "teste@teste.com.br",
"estadoCivil": "SOLTEIRO",
"nascimento": "1999-10-04",
"admissao": "2005-09-10",
"ocupacao": {
"id": 1
}
}Excluir fiador
Exclui o fiador de um cliente.
| Requisição | |
| Método | DELETE |
| URL | /api/v1/clientes/{id}/fiadores/{fiadorId} |
| Parâmetro de URL | |
id |
Código identificador do cliente |
fiadorId |
Código identificador do fiador |
| Exemplo de uso | |
/api/v1/clientes/12345/fiadores/1 |
|