Endereços do aluno

Os endereços guardam o local de um aluno. Eles pertencem ao cadastro de pessoa do aluno, identificado por customer_vendor_uuid. O aluno também pode ter o endereço informado no próprio cadastro (POST e PUT em Alunos), que grava o endereço principal da pessoa.

O customer_vendor_uuid vem no campo de mesmo nome da listagem de alunos, GET /administrative/students, e não é o uuid do aluno.

Esta página não tem tela própria no manual: os campos de endereço aparecem no cadastro de Alunos.

Endpoints

Método	Caminho	Descrição
GET	/administrative/students/{customer_vendor_uuid}/addresses	Lista os endereços da pessoa
POST	/administrative/students/{customer_vendor_uuid}/addresses	Cadastra o endereço da pessoa
GET	/administrative/students/{customer_vendor_uuid}/addresses/{id}	Consulta um endereço
PUT	/administrative/students/{customer_vendor_uuid}/addresses/{id}	Altera um endereço
DELETE	/administrative/students/{customer_vendor_uuid}/addresses/{id}	Apaga um endereço

GET /administrative/students/{customer_vendor_uuid}/addresses

Lista os endereços da pessoa.

Parâmetros de URL

Parâmetro	Descrição
per_page	Quantidade de registros por página
page	Número da página, quando per_page é informado

Resposta (200): lista de endereços, direta ou paginada. Campos principais: id, customer_vendor_id, zip_code, street, number, complement, neighborhood, city, state, user_create_name e user_update_name.

POST /administrative/students/{customer_vendor_uuid}/addresses

Cadastra o endereço da pessoa. Cada pessoa tem um único endereço: se ela já tiver um, os dados enviados substituem o endereço existente, e não é criado outro.

Corpo (JSON)

Campo	Obrigatório	Tipo	Descrição
zip_code	Não	Texto	CEP
street	Não	Texto	Rua ou avenida
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): o endereço criado ou atualizado.

Exemplo:

curl -X POST https://api.pedagogo.app/administrative/students/<customer-vendor-uuid>/addresses \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Content-Type: application/json" \
  -d '{"zip_code": "00000-000", "street": "Rua exemplo", "number": "100", "city": "Cidade exemplo", "state": "SP"}'

GET /administrative/students/{customer_vendor_uuid}/addresses/{id}

Devolve um endereço pelo id. Se o id não existir no cliente, a resposta é 200 com o corpo null.

PUT /administrative/students/{customer_vendor_uuid}/addresses/{id}

Altera um endereço. Envie apenas os campos que devem mudar, com os mesmos nomes da tabela de cadastro.

Corpo (JSON): os campos zip_code, street, number, complement, neighborhood, city e state, todos opcionais.

Resposta (200): o endereço alterado.

DELETE /administrative/students/{customer_vendor_uuid}/addresses/{id}

Apaga o endereço. A exclusão é lógica.

Resposta (200): sem conteúdo relevante (null).