Cliente | Contatos
Este artigo documenta o processo para inserir, editar e deletar um contato de um cliente.
Recurso responsável pelas informações dos contatos de um cliente.
Inserir contato
Insere o contato de um cliente.
| Requisição |
|
| Método |
POST |
| URL |
/api/v1/clientes/{id}/contatos |
| Formato do conteúdo |
application/json |
| Parâmetro de URL |
|
id |
Código identificador do cliente |
| Exemplo de uso |
/api/v1/clientes/12345/contatos |
Estrutura de dados da requisição
|
|
|
|
|
| Propriedade |
Tipo |
Tamanho |
Obrigatório |
Descrição |
nome |
String |
40 |
Não |
Nome |
endereco |
String |
40 |
Não |
Endereço |
bairro |
String |
25 |
Não |
Bairro |
cep |
String |
9 |
Não |
Cep |
municipio |
Object |
- |
Não |
Município do contato |
municipio.id |
Integer |
- |
Sim |
Código do municópio |
telefone |
String |
20 |
Não |
Telefone |
celular |
String |
20 |
Não |
Celular |
email |
String |
60 |
Não |
E-mail |
departamento |
String |
60 |
Não |
Departamento |
funcao |
String |
25 |
Não |
Função |
observacao |
String |
200 |
Não |
Observação |
{
"nome": "Contato 1",
"endereco": "Rua 5",
"bairro": "Centro",
"cep": "89874-000",
"municipio": {
"id": 1
},
"telefone": "(49) 0000-0000",
"celular": "(49) 00000-0000",
"email": "teste@teste.com.br",
"departamento": "TI",
"funcao": "Analisa",
"observacao": "Observação do contato"
}
Resposta
A API retornará o código identificador do contato inserido.
Estrutura de dados do resposta
|
|
|
|
|
| Propriedade |
Tipo |
Tamanho |
Obrigatório |
Descrição |
id |
Integer |
- |
Sim |
Código identificador do contato |
Exemplo de resposta
{
"id": 999
}
Editar contato
Atualiza o contato de um cliente.
| Requisição |
|
| Método |
PUT |
| URL |
/api/v1/clientes/{id}/contatos/{contatoId} |
| Formato do conteúdo |
application/json |
| Parâmetro de URL |
|
id |
Código identificador do cliente |
contatoId |
Código identificador do contato |
| Exemplo de uso |
/api/v1/clientes/123456/contatos/999 |
Estrutura de dados da requisição
|
|
|
|
|
| Propriedade |
Tipo |
Tamanho |
Obrigatório |
Descrição |
nome |
String |
40 |
Não |
Nome |
endereco |
String |
40 |
Não |
Endereço |
bairro |
String |
25 |
Não |
Bairro |
cep |
String |
9 |
Não |
Cep |
municipio |
Object |
- |
Não |
Município do contato |
municipio.id |
Integer |
- |
Sim |
Código do municópio |
telefone |
String |
20 |
Não |
Telefone |
celular |
String |
20 |
Não |
Celular |
email |
String |
60 |
Não |
E-mail |
departamento |
String |
60 |
Não |
Departamento |
funcao |
String |
25 |
Não |
Função |
observacao |
String |
200 |
Não |
Observação |
{
"nome": "Contato 1 editado",
"endereco": "Rua 5",
"bairro": "Centro",
"cep": "89874-000",
"municipio": {
"id": 1
},
"telefone": "(49) 0000-0000",
"celular": "(49) 00000-0000",
"email": "teste@teste.com.br",
"departamento": "TI",
"funcao": "Analisa",
"observacao": "Observação do contato"
}
Excluir contato
Exclui o contato de um cliente.
| Requisição |
| Método |
DELETE |
| URL |
/api/v1/clientes/{id}/contatos/{contatoId} |
| Parâmetro de URL |
|
id |
Código identificador do cliente |
contatoId |
Código identificador do contato |
| Exemplo de uso |
/api/v1/clientes/123456/contatos/999 |
