Cliente | Atividades
Este artigo documenta o processo para inserir, editar e deletar uma ativade de um cliente.
Recurso responsável pelas informações das atividades de um cliente.
Inserir atividade
Insere uma atividade de um cliente.
| Requisição | |
| Método | POST |
| URL | /api/v1/clientes/{id}/atividades |
| Formato do conteúdo | application/json |
| Parâmetro de URL | |
id |
Código identificador do cliente |
| Exemplo de uso | |
/api/v1/clientes/12345/atividades |
|
|
Estrutura de dados da requisição |
||||
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
nomeEmpresa |
String | 60 | Sim | Nome da empresa |
contato |
String | 100 | Não | Contato |
telefone |
String | 15 | Não | Telefone |
municipio |
Object | - | Não | Município |
municipio.id |
Integer | - | Sim | Código do município |
tipo |
Object | - | Sim | Tipo da atidade |
tipo.id |
Integer | - | Sim | Código do tipo da atividade |
atividadePrincipal |
String | 3 | Sim |
Atividade principal SIM NAO |
unidadeMedida |
Object | - | Sim | Unidade fornecida |
unidadeMedida.id |
Integer | - | Sim | Código da unidade de medida |
quantidade |
Double | - | Não | Quantidade |
anosFornecimento |
Integer | - | Não | Anos de fornecimento |
mesesFornecimento |
Integer | - | Não | Meses de fornecimento |
renda |
Double | - | Sim | Renda |
previsaoAumento |
Double | - | Não | Previsão aumento |
periodicidadeRenda |
String | 10 | Não | Periodicidade de renda ANUAL SEMESTRAL TRIMESTRAL BIMESTRAL MENSAL SEMANAL DIARIO |
observacoes |
Não | Observações |
Exemplo da requisição
{
"nomeEmpresa": "Teste",
"contato": "Contato atividade",
"telefone": "(49) 0000-0000",
"municipio": {
"id": 1
},
"tipo": {
"id": 1
},
"atividadePrincipal": "NAO",
"unidadeMedida": {
"id": "LT"
},
"quantidade": 67.5,
"anosFornecimento": 1,
"mesesFornecimento": 2,
"renda": 10,
"previsaoAumento": 10,
"periodicidadeRenda": "DIARIO",
"observacoes": "Obs atividade"
}Resposta
A API retornará o código identificador da atividade inserida.
|
Estrutura de dados do resposta |
||||
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
id |
Integer | - | Sim | Código identificador da atividade |
Exemplo de resposta
{
"id": 1
}Editar atividade
Atualiza uma atividade de um cliente.
| Requisição | |
| Método | PUT |
| URL | /api/v1/clientes/{id}/atividades/{atividadeId} |
| Formato do conteúdo | application/json |
| Parâmetro de URL | |
id |
Código identificador do cliente |
atividadeId |
Código identificador da atividade |
| Exemplo de uso | |
/api/v1/clientes/12345/atividades/1 |
|
|
Estrutura de dados da requisição |
||||
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
nomeEmpresa |
String | 60 | Sim | Nome da empresa |
contato |
String | 100 | Não | Contato |
telefone |
String | 15 | Não | Telefone |
municipio |
Object | - | Não | Município |
municipio.id |
Integer | - | Sim | Código do município |
tipo |
Object | - | Sim | Tipo da atidade |
tipo.id |
Integer | - | Sim | Código do tipo da atividade |
atividadePrincipal |
String | 3 | Sim |
Atividade principal SIM NAO |
unidadeMedida |
Object | - | Sim | Unidade fornecida |
unidadeMedida.id |
Integer | - | Sim | Código da unidade de medida |
quantidade |
Double | - | Não | Quantidade |
anosFornecimento |
Integer | - | Não | Anos de fornecimento |
mesesFornecimento |
Integer | - | Não | Meses de fornecimento |
renda |
Double | - | Sim | Renda |
previsaoAumento |
Double | - | Não | Previsão aumento |
periodicidadeRenda |
String | 10 | Não | Periodicidade de renda ANUAL SEMESTRAL TRIMESTRAL BIMESTRAL MENSAL SEMANAL DIARIO |
observacoes |
Não | Observações |
Exemplo da requisição
{
"nomeEmpresa": "Teste",
"contato": "Contato atividade",
"telefone": "(49) 0000-0000",
"municipio": {
"id": 1
},
"tipo": {
"id": 1
},
"atividadePrincipal": "NAO",
"unidadeMedida": {
"id": "LT"
},
"quantidade": 67.5,
"anosFornecimento": 1,
"mesesFornecimento": 2,
"renda": 10,
"previsaoAumento": 10,
"periodicidadeRenda": "DIARIO",
"observacoes": "Obs atividade"
}Excluir ativade
Exclui uma atividade de um cliente.
| Requisição | |
| Método | DELETE |
| URL | /api/v1/clientes/{id}/atividades/{atividadeId} |
| Parâmetro de URL | |
id |
Código identificador do cliente |
atividadeId |
Código identificador da atividade |
| Exemplo de uso | |
/api/v1/clientes/12345/atividades/1 |
|