Detalhar aluno

Escopo: students:read — Ficha completa do aluno: cadastro, assinatura (com CPF/CNPJ), turmas e presenças.

Um aluno pelo id (:studentId — o mesmo de studentIds em Listar turmas e de students[].id em Detalhar turma), com a assinatura completa, as turmas e as presenças. Aluno de outro estabelecimento responde 404.

student: cadastro. birthday é texto livre, como digitado. notes é a observação do estabelecimento sobre o aluno. enabled: false = aluno desativado.

payment: situação de pagamento pela mesma regra de Detalhar turma (UP_TO_DATE, PENDING, OVERDUE, INACTIVE, NO_SUBSCRIPTION), pelas faturas em aberto da assinatura.

subscription: a assinatura do aluno no mesmo formato de Listar assinantes — responsável (client, com CPF/CNPJ), plano, preço, vencimentos e campos personalizados. null sem assinatura, ou com subscriptionId preenchido se a assinatura foi apagada.

classes: turmas de que o aluno faz parte, com os campos de Listar turmas (menos a lista de alunos) e mais:

  • enrollment: onde o vínculo está gravado — inClassList (na turma) e inStudentRecord (no cadastro do aluno). Os dois deveriam andar juntos; false em um deles indica vínculo quebrado, e a turma aparece mesmo assim.
  • attendance: total, summary por status e records da aula mais recente para a mais antiga. date é o início da aula; recordedAt, quando a presença foi marcada (null em registros antigos). Status: PRESENT, ABSENT, LATE, CANCELLED, UNDEFINED.

formerClasses: turmas de que o aluno não faz mais parte, mas onde ele tem presença registrada — mesmo formato, sem enrollment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

O mesmo de studentIds em Listar turmas.

Query Params
string

uid do estabelecimento. Dispensável com chave exclusiva de um estabelecimento; obrigatório nas demais.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json