Listar matrículas

GET

https://api.eduzz.com/nutror/v1/students/:id/enrollments

Required scopes:nutror_my_students_read

Lista matrículas do aluno

Path params

Id do aluno

Query params

page

number

Página atual

itemsPerPage

number

Número de itens por página

Response params (200)

pages

number

Número de páginas

page

number

Página atual

itemsPerPage

number

Número máximo de itens por página

totalItems

number

Número total de items

items

array of object

items[n].id

string

Id da matrícula

items[n].createdAt

datetime

Data da matrícula

items[n].status

enum

Status da matrícula

active

inactive

items[n].allModulesReleasedNullable

boolean

Todos os módulos foram entregues

items[n].expiredAtNullable

datetime

Data de expiração da matrícula

items[n].acceptedTermAtNullable

datetime

Data que aceitou o termo da matrícula

items[n].content

object

items[n].content.type

enum

course

package

items[n].content.courses

array of object

items[n].content.courses[n].title

string

Título do curso

items[n].content.courses[n].hash

string

Hash do curso

items[n].progress

number

Progresso do aluno nessa matrícula

Status codes

Status	Descrição
200	Success
404	Aluno não encontrado

Exemplos

1curl --request GET \
2	--url https://api.eduzz.com/nutror/v1/students/12345/enrollments \
3	--header 'Accept: application/json' \
4	--header 'Content-Type: application/json' \
5	--header 'authorization: Bearer {{YOUR_ACCESS_TOKEN}}'

Response

1{
2  "pages": 1,
3  "page": 1,
4  "itemsPerPage": 50,
5  "totalItems": 1,
6  "items": [
7    {
8      "id": "20061",
9      "createdAt": "2024-10-02T15:25:18+00:00",
10      "status": "inactive",
11      "allModulesReleased": true,
12      "expiredAt": null,
13      "acceptedTermAt": null,
14      "content": {
15        "type": "course",
16        "courses": [
17          {
18            "title": "Um título qualquer",
19            "hash": "33f2e32dfaab93a81f552b5ac1273d44432048v2"
20          }
21        ]
22      },
23      "progress": 0
24    }
25  ]
26}