Cliente | Bens
Este artigo documenta o processo para inserir, editar e deletar um bem de um cliente.
Recurso responsável pelas informações dos bens de um cliente.
Inserir bem
Insere um bem de um cliente.
| Requisição | |
| Método | POST |
| URL | /api/v1/clientes/{id}/bens |
| Formato do conteúdo | application/json |
| Parâmetro de URL | |
id |
Código identificador do cliente |
| Exemplo de uso | |
/api/v1/clientes/12345/bens |
|
|
Estrutura de dados da requisição |
||||
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
descricao |
String | 100 | Não | Descrição do bem |
localizacao |
String | 100 | Não | Localização do bem |
valor |
Double | Não | Valor do bem | |
observacao |
String | 100 | Não | Observação |
tipo |
String | 10 | Sim |
Tipo do bem MOVEL IMOVEL |
condicao |
String | 10 | Sim |
Condição do bem PROPRIO ALUGADO CEDIDO |
anosAquisicao |
Integer | - | Não | Anos da aquisição |
mesesAquisicao |
Integer | - | Não | Meses da aquisição |
areaTotal |
Double | - | Não | Área total do bem |
areaReservada |
Double | - | Não | Área reservada do bem |
alienado |
String | 3 | Sim |
Alienado SIM NAO |
Exemplo da requisição
{
"descricao": "Teste",
"localizacao": "maravilha",
"valor": 2556888.00,
"obsevacao": "Obs bem",
"tipo": "IMOVEL",
"condicao": "ALUGADO",
"anosAquisicao": 2,
"mesesAquisicao": 6,
"areaTotal": 256.5,
"areaReservada": 2.56,
"alienado": "SIM"
}Resposta
A API retornará o código identificador do bem inserido.
|
Estrutura de dados do resposta |
||||
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
id |
Integer | - | Sim | Código identificador do bem |
Exemplo de resposta
{
"id": 1
}Editar bem
Atualiza um bem de um cliente.
| Requisição | |
| Método | PUT |
| URL | /api/v1/clientes/{id}/bens/{bemId} |
| Formato do conteúdo | application/json |
| Parâmetro de URL | |
id |
Código identificador do cliente |
bemId |
Código identificador do bem |
| Exemplo de uso | |
/api/v1/clientes/12345/bens/1 |
|
|
Estrutura de dados da requisição |
||||
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
descricao |
String | 100 | Não | Descrição do bem |
localizacao |
String | 100 | Não | Localização do bem |
valor |
Double | Não | Valor do bem | |
observacao |
String | 100 | Não | Observação |
tipo |
String | 10 | Sim |
Tipo do bem MOVEL IMÓVEL |
condicao |
String | 10 | Sim |
Condição do bem PROPRIO ALUGADO CEDIDO |
anosAquisicao |
Integer | - | Não | Anos da aquisição |
mesesAquisicao |
Integer | - | Não | Meses da aquisição |
areaTotal |
Double | - | Não | Área total do bem |
areaReservada |
Double | - | Não | Área reservada do bem |
alienado |
String | 3 | Sim |
Alienado SIM NAO |
Exemplo da requisição
{
"descricao": "Teste",
"localizacao": "maravilha",
"valor": 2556888.00,
"obsevacao": "Obs bem",
"tipo": "IMOVEL",
"condicao": "ALUGADO",
"anosAquisicao": 2,
"mesesAquisicao": 6,
"areaTotal": 256.5,
"areaReservada": 2.56,
"alienado": "SIM"
}Excluir bem
Exclui um bem de um cliente.
| Requisição | |
| Método | DELETE |
| URL | /api/v1/clientes/{id}/bens/{bemId} |
| Parâmetro de URL | |
id |
Código identificador do cliente |
bemId |
Código identificador do bem |
| Exemplo de uso | |
/api/v1/clientes/12345/bens/1 |
|