API Reference

Listar matrículas

get
https://{tenant}.{environment}.educbank.com.br/api/ebpay/enrollment
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Nome do estudante

string

Código do Estudante

string

Nome do responsável financeiro principal

string

Nome da turma

uuid

Id da Escola

uuid

Id da Turma

int32
1 to 2147483647

Ano letivo

string

Curso referente à matrícula

string

CNPJ da Empresa

date-time

Data de criação da matrícula

string

Id externo da matrícula

string
enum

Status da matrícula, podem ser eles: Active, Canceled, Evaded, InProgress, AtRisk, NotEnrollable, ToEnroll

Allowed:
string

Filtro global. Podem ser passados os valores dos seguintes campos: Nome do estudante, Nome de um dos responsáveis financeiro.

string

Determina como ordernar a lista em relação ao "sortType". ex: asc, desc

string

Determina a ordenação pelo campo informado. ex: StudentName, GuardianName, AcademicClassName etc

boolean

Determina a exibição de matrículas canceladas. True para exibir matrículas canceladas

string
enum

Determina a exibição de matrículas com o status financeiro informado: Ex: "InDebt" or "NotInDebt"

Allowed:
date-time

Filtra pela data de nascimento do estudante.

string

Filtra pelo documento do Responsável Financeiro

uuid
int32
0 to 2147483647
int32
1 to 2147483647
Responses

Updated 10 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago

Did this page help you?