Pré-matrículas

Os endpoints desta página atendem a tela Matrículas, que guarda as pré-matrículas: o registro de uma intenção de matrícula, feito antes do cadastro definitivo do aluno. Use a pré-matrícula para reservar uma vaga ou anotar que uma pessoa quer fazer um curso.

Uma pré-matrícula não gera matrícula. Ela fica registrada como intenção, e nenhum endpoint desta página a converte em matrícula. A matrícula é feita depois, pelas telas Alunos online (matrícula avulsa) ou Turmas (matrícula em turma), quando o aluno já estiver cadastrado.

Endpoints

Método	Caminho	Descrição
GET	/comercial/enrollments/pre-enrollments	Lista as pré-matrículas do cliente.
POST	/comercial/enrollments/pre-enrollments	Cria uma pré-matrícula.
GET	/comercial/enrollments/pre-enrollments/{uuid}	Consulta uma pré-matrícula.
PUT	/comercial/enrollments/pre-enrollments/{uuid}	Altera uma pré-matrícula.
DELETE	/comercial/enrollments/pre-enrollments/{uuid}	Apaga uma pré-matrícula.
GET	/comercial/enrollments/pre-enrollments/business	Lista de apoio: empresas ativas.
GET	/comercial/enrollments/pre-enrollments/classes	Lista de apoio: turmas.
GET	/comercial/enrollments/pre-enrollments/courses	Lista de apoio: cursos.
GET	/comercial/enrollments/pre-enrollments/students	Lista de apoio: alunos cadastrados.
GET	/comercial/enrollments/pre-enrollments/training-students	Lista de apoio: alunos de treinamento (matrículas).

Pré-matrículas

GET /comercial/enrollments/pre-enrollments

Lista as pré-matrículas do cliente. Sem per_page, a resposta é a lista direta. Com per_page, a resposta vem paginada, como descrito em Convenções.

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
search	Não	Texto livre: busca pelo nome, pelo e-mail e pelo documento da pré-matrícula.
course_id	Não	Número do curso (id).
class_id	Não	Número da turma (id).
customer_vendor_business_id	Não	Número da empresa (id).
customer_vendor_student_id	Não	Número do aluno cadastrado (id).
student_id	Não	Número do aluno de treinamento (id).
column	Não	Coluna usada na ordenação. Usada junto com order.
order	Não	Sentido da ordenação, como asc ou desc. Usado junto com column.
per_page	Não	Quantidade de registros por página.
page	Não	Número da página, quando per_page é informado.

Resposta

200, com a lista de pré-matrículas. Campos principais: uuid, name, email, document, cellphone, course_uuid, course_name, class_uuid, business_uuid, business_name, student_name e client_name.

Exemplo:

curl -G "https://api.pedagogo.app/comercial/enrollments/pre-enrollments" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data-urlencode "search=Maria" \
  --data-urlencode "per_page=15"

POST /comercial/enrollments/pre-enrollments

Cria uma pré-matrícula. O servidor gera o uuid e associa o registro ao cliente da sessão.

Corpo

Campo	Obrigatório	Tipo	Descrição
course_id	Sim	Texto (uuid)	uuid do curso pretendido. O curso precisa existir.
class_id	Não	Texto (uuid)	uuid da turma, se já houver uma escolhida.
name	Sim	Texto	Nome da pessoa que pretende se matricular.
business_uuid	Não	Texto (uuid)	uuid da empresa que indica ou paga pela pessoa.

Resposta

200, com o registro criado, incluindo o uuid. Nesse registro, course_id, class_id e customer_vendor_business_id são os ids internos, não os uuids enviados.

Exemplo:

curl -X POST "https://api.pedagogo.app/comercial/enrollments/pre-enrollments" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "course_id": "<uuid-do-curso>",
    "name": "Pessoa exemplo"
  }'

Consultar, alterar e apagar

GET /comercial/enrollments/pre-enrollments/{uuid}

Devolve a pré-matrícula identificada por {uuid}, com os mesmos campos da listagem.

PUT /comercial/enrollments/pre-enrollments/{uuid}

Altera uma pré-matrícula. Envie só os campos que quer mudar: os campos omitidos mantêm o valor atual.

Corpo

Campo	Obrigatório	Tipo	Descrição
course_id	Não	Texto (uuid)	uuid do novo curso pretendido. O curso precisa existir.
class_id	Não	Texto (uuid)	uuid da turma. A turma precisa existir.
name	Não	Texto	Nome da pessoa.
email	Não	Texto (e-mail)	E-mail de contato. Precisa ter formato de e-mail.
business_uuid	Não	Texto (uuid)	uuid da empresa. A empresa precisa existir.

Resposta

200, com o registro alterado.

DELETE /comercial/enrollments/pre-enrollments/{uuid}

Apaga a pré-matrícula identificada por {uuid}. A exclusão é lógica: o registro deixa de aparecer nas listagens. A resposta é 200, sem corpo.

Listas auxiliares

Estas consultas alimentam os campos de seleção do formulário de pré-matrícula. Cada uma devolve a lista do cliente da sessão.

• business: empresas ativas (clientes empresariais que não estão inativos). Use o uuid como business_uuid.
• classes: turmas do cliente. Use o uuid como class_id.
• courses: cursos do cliente. Use o uuid como course_id.
• students: alunos cadastrados do cliente.
• training-students: alunos de treinamento, ou seja, matrículas já existentes do cliente.