Endereço do instrutor
O endereço da pessoa ligada ao instrutor. Na tela Instrutores, os campos de endereço ficam no formulário do cadastro. Cada pessoa tem um único endereço: se ele já existir, a criação atualiza o existente, em vez de criar outro.
Use o customer_vendor.uuid do instrutor nos caminhos abaixo.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/instructors/{customer_vendor_uuid}/addresses | Lista os endereços |
| POST | /administrative/instructors/{customer_vendor_uuid}/addresses | Cadastra o endereço |
| GET | /administrative/instructors/{customer_vendor_uuid}/addresses/{id} | Consulta um endereço |
| PUT | /administrative/instructors/{customer_vendor_uuid}/addresses/{id} | Altera um endereço |
| DELETE | /administrative/instructors/{customer_vendor_uuid}/addresses/{id} | Apaga um endereço |
O {id} é o id numérico do endereço.
Endpoints de endereço
GET /administrative/instructors/{customer_vendor_uuid}/addresses
Lista os endereços do cadastro. Aceita per_page e page.
Resposta: 200, lista de endereços com id, customer_vendor_id, zip_code,
street, number, complement, neighborhood, city, state e os nomes de quem
criou e alterou o registro.
POST /administrative/instructors/{customer_vendor_uuid}/addresses
Cadastra o endereço. Se o cadastro já tiver endereço, o existente é reativado e atualizado com os campos enviados.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| zip_code | Não | Texto | CEP |
| street | Não | Texto | Endereço (rua) |
| number | Não | Texto | Número |
| complement | Não | Texto | Complemento |
| neighborhood | Não | Texto | Bairro |
| city | Não | Texto | Cidade |
| state | Não | Texto | Estado |
Resposta: 201, com o endereço.
GET /administrative/instructors/{customer_vendor_uuid}/addresses/{id} e DELETE /administrative/instructors/{customer_vendor_uuid}/addresses/{id}
Consultar e apagar um endereço. A exclusão é lógica.
Resposta: 200.
PUT /administrative/instructors/{customer_vendor_uuid}/addresses/{id}
Altera um endereço. Envie somente os campos que mudam, com os mesmos campos da criação.
Resposta: 200, com o endereço alterado.