Esta API oferece um conjunto de endpoints projetados para facilitar o gerenciamento de matrículas escolares, permitindo que sistemas integrados realizem o acompanhamento completo do ciclo de matrícula de estudantes em instituições de ensino. Os recursos disponibilizados possibilitam o controle desde o registro inicial do estudante até a atualização de status e o cancelamento de matrículas, proporcionando uma experiência de gestão educacional centralizada e eficiente.
GET /enrollment/v1/accounts/{id}/courses
Content-Type: application/json
Authorization: Bearer [TOKEN JWT]
| Parameter | Type | Description |
|---|---|---|
id |
string |
Obrigatório. Account ID. |
200 Ok
Example do corpo da resposta:
{
"data": [
{
"school_id": "", // String: ID da escola (UUID).
"code": "", // String: código do curso.
"name": "", // String: nome do curso.
"grade_id": "", // String: ID da série (UUID).
"grade": "", // String: nome da série.
"educational_stage_id": "", // String: ID da etapa educacional (UUID).
"educational_stage": "", // String: nome da etapa educacional.
"year": "", // Numérico: ano escolar.
"shift_id": "", // String: ID do turno escolar (UUID).
"shift": "", // String: turno escolar.
"status": "" // String: status da matrícula.
}
]
}
401 Unauthorized
400 BadRequest
Example do corpo da resposta:
{
"Errors": [
{
"Code": "XPTO-0000",
"Message": ""
}
]
}
500 BadRequest
//Exemplo do Resposta body:
{
"Errors": [
{
"Code": 500,
"Message": "Não foi possível concluir seu pedido no momento."
}
]
}
PUT /enrollment/v1/accounts/{id}
Content-Type: application/json
Authorization: Bearer [TOKEN JWT]
| Parameter | Type | Description |
|---|---|---|
id |
string |
Obrigatório. Id da conta do usuário. |
{
"data": [
{
"school_id": "", // String: Id da escola (UUID).
"course_code": "", // String: código do curso.
"status": "", // String: o novo status de matrícula.
"payer_id": "", // String: Id da conta do pagador.
"operator": "", // String: nome da pessoa responsável pela operação de cancelamento.
"notes": "", // String: notas sobre a operação (máximo de 512 caracteres).
"updated_at": "" // Timestamp: data e hora da operação representadas de acordo com o ISO 8601 (expressas em UTC).
}
]
}
200 Ok
401 Unauthorized
400 BadRequest
Example do corpo da resposta:
{
"Errors": [
{
"Code": "XPTO-0000",
"Message": ""
}
]
}
500 BadRequest
//Exemplo do Resposta body:
{
"Errors": [
{
"Code": 500,
"Message": "Não foi possível concluir seu pedido no momento."
}
]
}
PUT /enrollment/v1/user/{userId}
Content-Type: application/json
Authorization: Bearer [TOKEN JWT]
| Parameter | Type | Description |
|---|---|---|
userId |
string |
Obrigatório. ID do usuário. |
{
"data": [
{
"school_id": "", // String: Id da escola (UUID).
"course_code": "", // String: código do curso.
"status": "", // String: o novo status de matrícula.
"payer_id": "", // String: Id da conta do pagador.
"operator": "", // String: nome da pessoa responsável pela operação de cancelamento.
"notes": "", // String: notas sobre a operação (máximo de 512 caracteres).
"updated_at": "" // Timestamp: data e hora da operação representadas de acordo com o ISO 8601 (expressas em UTC).
}
]
}
200 Ok
401 Unauthorized
400 BadRequest
Example do corpo da resposta:
{
"Errors": [
{
"Code": "XPTO-0000",
"Message": ""
}
]
}
500 BadRequest
//Exemplo do Resposta body:
{
"Errors": [
{
"Code": 500,
"Message": "Não foi possível concluir seu pedido no momento."
}
]
}
POST /enrollment/v1/schools/{id}/courses/{code}/status
Content-Type: application/json
Authorization: Bearer [TOKEN JWT]
| Parameter | Type | Description |
|---|---|---|
id |
string |
Obrigatório. ID da escola. |
code |
string |
Obrigatório. Codigo do curso. |
{
"data": {
"user_id": "", // String: ID do usuário LEX (UUID).
"external_id": "", // String: ID do usuário dependente no sistema externo.
"name": "", // String: nome da pessoa.
"email": "", // String: endereço de e-mail.
"phone": "", // String: número de celular.
"document_type": "", // String: tipo de documento de identificação.
"document": "", // String: documento de identificação.
"school_id": "", // String: ID da escola (UUID).
"course_code": "", // String: código do curso.
"status": "", // String: novo status de matrícula.
"updated_at": "", // Timestamp: data e hora da operação representadas de acordo com o ISO 8601 (expressas em UTC).
"date_of_birth": "", // String: data de nascimento.
"responsible": [{
"user_id": "", // String: ID do usuário LEX (UUID).
"external_id": "", // String: ID do usuário responsável no sistema externo.
"name": "", // String: nome da pessoa.
"email": "", // String: endereço de e-mail.
"phone": "", // String: número de celular.
"document_type": "", // String: tipo de documento de identificação.
"document": "", // String: documento de identificação.
"date_of_birth": "" // String: data de nascimento.
}]
}
}
200 Ok
401 Unauthorized
400 BadRequest
Example do corpo da resposta:
{
"Errors": [
{
"Code": "XPTO-0000",
"Message": ""
}
]
}
500 BadRequest
//Exemplo do Resposta body:
{
"Errors": [
{
"Code": 500,
"Message": "Não foi possível concluir seu pedido no momento."
}
]
}