get
https://southamerica-east1-lepapptest.cloudfunctions.net/lepApi/v1/classes/
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 | |
|---|---|
bizId | query 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:truesó emUP_TO_DATE;nullsem assinatura.oldestOpenDueDateé o vencimento da fatura em aberto mais antiga.subscription.responsibleName: responsável financeiro (clientNameda assinatura).dueDateé o vencimento mostrado na lista de assinantes do app;nextDueDate, o seguinte.subscription: nullcomsubscriptionIdpreenchido = 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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
