Detalhar turma

Escopo: classes:read — Turmas e seus alunos (nome, aniversário, contato, assinatura e situação de pagamento).

Uma turma pelo id (:classId, o id de Listar turmas), com os mesmos campos da lista e os alunos detalhados. Turma excluída também responde, com status: DELETED. Turma de outro estabelecimento responde 404.

parâmetro
bizIdquery string. Dispensável com chave exclusiva de um estabelecimento

students[] (por nome)

  • birthday: texto livre, como digitado no cadastro do aluno (o app não valida o formato).
  • enabled: false = aluno desativado.
  • payment.status — mesma regra da aba Alunos do app, pelas faturas em aberto da assinatura:
    • UP_TO_DATE: assinatura sem fatura em aberto;
    • PENDING: fatura em aberto ainda no prazo;
    • OVERDUE: fatura em aberto com vencimento passado;
    • INACTIVE: aluno desativado (não está sendo cobrado);
    • NO_SUBSCRIPTION: aluno sem assinatura.
  • payment.paid: true só em UP_TO_DATE; null sem assinatura. oldestOpenDueDate é o vencimento da fatura em aberto mais antiga.
  • subscription.responsibleName: responsável financeiro (clientName da assinatura). dueDate é o vencimento mostrado na lista de assinantes do app; nextDueDate, o seguinte. subscription: null com subscriptionId preenchido = assinatura apagada.

missingStudentIds: ids que estão na turma, mas cujo aluno não existe mais. O app também não os mostra.

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

id de 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