Contatos do instrutor
As pessoas de contato ligadas ao cadastro do instrutor. A tela Instrutores não tem aba de contatos; os campos de contato da pessoa ficam no formulário do instrutor.
Use o customer_vendor.uuid do instrutor (o uuid do cadastro da pessoa, retornado na
consulta do instrutor) nos caminhos abaixo.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/instructors/{customer_vendor_uuid}/contacts | Lista os contatos |
| POST | /administrative/instructors/{customer_vendor_uuid}/contacts | Cadastra um contato |
| GET | /administrative/instructors/{customer_vendor_uuid}/contacts/{id} | Consulta um contato |
| PUT | /administrative/instructors/{customer_vendor_uuid}/contacts/{id} | Altera um contato |
| DELETE | /administrative/instructors/{customer_vendor_uuid}/contacts/{id} | Apaga um contato |
O {id} é o id numérico do contato.
Endpoints de contatos
GET /administrative/instructors/{customer_vendor_uuid}/contacts
Lista os contatos do cadastro.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| search | Busca pelo nome do contato |
| select_email | Quando informado, devolve só id, name e email |
| select_cellphone | Quando informado, devolve só id, name e cellphone |
| per_page e page | Paginação |
Resposta: 200, lista de contatos com id, customer_vendor_id, name, email,
phonenumber e cellphone.
POST /administrative/instructors/{customer_vendor_uuid}/contacts
Cadastra um contato.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| name | Sim | Texto | Nome da pessoa de contato |
| Não | Texto | E-mail do contato | |
| cellphone | Não | Texto | Celular do contato |
| phonenumber | Não | Texto | Telefone do contato |
Resposta: 201, com o contato criado.
GET /administrative/instructors/{customer_vendor_uuid}/contacts/{id} e DELETE /administrative/instructors/{customer_vendor_uuid}/contacts/{id}
Consultar e apagar um contato. A exclusão é lógica.
Resposta: 200.
PUT /administrative/instructors/{customer_vendor_uuid}/contacts/{id}
Altera um contato. Envie somente os campos que mudam, com os mesmos campos da criação.
Resposta: 200, com o contato alterado.