Cliente | Sócios
Este artigo documenta o processo para inserir, editar e deletar um sócio de um cliente.
Recurso responsável pelas informações dos sócios de um cliente.
Inserir sócio
Insere um sócio de um cliente.
| Requisição | |
| Método | POST |
| URL | /api/v1/clientes/{id}/socios |
| Formato do conteúdo | application/json |
| Parâmetro de URL | |
id |
Código identificador do cliente |
| Exemplo de uso | |
/api/v1/clientes/12345/socios |
|
|
Estrutura de dados da requisição |
||||
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
nome |
String | 60 | Não |
Nome do sócio |
responsavel |
Integer | Sim |
Responsável SIM NAO |
|
cpf |
String | 14 | Não |
CPF do sócio |
rg |
String | 20 | Não |
RG do sócio |
telefone |
String | 20 | Não |
Telefone do sócio |
celular |
String | 20 | Não |
Celular do sócio |
endereco |
String | 60 | Não |
Endereço do sócio |
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ípo |
email |
String | 100 | Não |
E-mail do sócio |
observacao |
String | 100 | Não |
observação |
nacionalidade |
String | 15 | Sim |
Nacionalidade NACIONAL INTERNACIONAL |
serasa |
Integer | 1 | Sim |
Desconsidera serasa: SIM |
Exemplo da requisição
{
"nome": "Teste",
"responsavel": "SIM",
"cpf": "000.000.000-88",
"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",
"observacao": "obs socio",
"nacionalidade": "NACIONAL",
"serasa": "NAO"
}Resposta
A API retornará o código identificador do sócio inserido.
|
Estrutura de dados do resposta |
||||
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
id |
Integer | - | Sim | Código identificador do sócio |
Exemplo de resposta
{
"id": 1
}Editar sócio
Atualiza um sócio de um cliente.
| Requisição | |
| Método | PUT |
| URL | /api/v1/clientes/{id}/socios/{socioId} |
| Formato do conteúdo | application/json |
| Parâmetro de URL | |
id |
Código identificador do cliente |
socioId |
Código identificador do sócio |
| Exemplo de uso | |
/api/v1/clientes/12345/socios/1 |
|
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
nome |
String | 60 | Não |
Nome do sócio |
responsavel |
Integer | 1 | Sim |
Responsável SIM NAO |
cpf |
String | 14 | Não |
CPF do sócio |
rg |
String | 20 | Não |
RG do sócio |
telefone |
String | 20 | Não |
Telefone do sócio |
celular |
String | 20 | Não |
Celular do sócio |
endereco |
String | 60 | Não |
Endereço do sócio |
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ípo |
email |
String | 100 | Não |
E-mail do sócio |
observacao |
String | 100 | Não |
observação |
nacionalidade |
String | 15 | Sim |
Nacionalidade NACIONAL INTERNACIONAL |
serasa |
Integer | 1 | Sim |
Desconsidera serasa: SIM |
Exemplo da requisição
{
"nome": "Teste",
"responsavel": "SIM",
"cpf": "000.000.000-88",
"rg": "0.000.000",
"telefone": "0000-0000",
"celular": "(49) 00000-0000",
"endereco": "Rua teste",
"numero": "10",
"bairro": "teste",
"municipio": {
"id": 2
},
"cep": "89874-000",
"email": "teste@teste.com.br",
"observacao": "obs socio",
"nacionalidade": "NACIONAL",
"serasa": "NAO"
}Excluir sócio
Exclui um sócio de um cliente.
| Requisição | |
| Método | DELETE |
| URL | /api/v1/clientes/{id}/socios/{socioId} |
| Parâmetro de URL | |
id |
Código identificador do cliente |
socioId |
Código identificador do sócio |
| Exemplo de uso | |
/api/v1/clientes/12345/socios/1 |
|