Pular para o conteúdo principal

Endereço do colaborador

O endereço da pessoa ligada ao colaborador. Na tela Colaboradores, 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 colaborador nos caminhos abaixo.

Endpoints​

MétodoCaminhoDescrição
GET/administrative/employees/{customer_vendor_uuid}/addressesLista os endereços
POST/administrative/employees/{customer_vendor_uuid}/addressesCadastra o endereço
GET/administrative/employees/{customer_vendor_uuid}/addresses/{id}Consulta um endereço
PUT/administrative/employees/{customer_vendor_uuid}/addresses/{id}Altera um endereço
DELETE/administrative/employees/{customer_vendor_uuid}/addresses/{id}Apaga um endereço

O {id} é o id numérico do endereço.

Endpoints de endereço​

GET /administrative/employees/{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/employees/{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

CampoObrigatórioTipoDescrição
zip_codeNãoTextoCEP
streetNãoTextoEndereço (rua)
numberNãoTextoNúmero
complementNãoTextoComplemento
neighborhoodNãoTextoBairro
cityNãoTextoCidade
stateNãoTextoEstado

Resposta: 201, com o endereço.

GET /administrative/employees/{customer_vendor_uuid}/addresses/{id} e DELETE /administrative/employees/{customer_vendor_uuid}/addresses/{id}​

Consultar e apagar um endereço. A exclusão é lógica.

Resposta: 200.

PUT /administrative/employees/{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.