Brein API

Student

Get all students with filters

GET

/api/v1/student

Retrieve a paginated list of students based on query parameters and user role

Get all students with filters › query Parameters

routeIdnumber · required
Route id
hideDeletedboolean · required
Filter out deleted students
pagenumber
Current page
pageSizenumber
Page size
groupIdnumber
Group ID
keystring
Filter by multiples key
birthDateFromstring · date-time
Birth date of the student (from)
birthDateTostring · date-time
Birth date of the student (to)
ignoreGroupIdnumber
Ignore Group ID
gradesnumber[]
Grade list
levelsstring[]
Level list

Get all students with filters › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GET /api/v1/student

curl --request GET \
  --url '/api/v1/student?routeId=1&hideDeleted=true'

shell

Show example in

Example Responses

No example

json

application/json

Create a new student

POST

/api/v1/student

Create a new student with the provided data

Create a new student › Request Body

bloodTypestring · required
Blood type of the student
Example: O+
birthDatestring · date-time · required
Birth date of the student
Example: 2025-01-23T10:00:00.000Z
gradestring · required
Grade level of the student
Example: 1
levelstring · required
School level of the student
Example: Primary
enrollmentstring · required
Enrollment number of the student
Example: 12345
firstNamestring · required
First name of the student
Example: John
lastNamestring · required
Last name of the student
Example: Doe
secondLastNamestring · required
Second last name of the user
Example: Smith
genrestring · required
Gender of the student
Example: FEMALE

familyIdnumber
Family Id

Create a new student › Responses

Student created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
bloodTypestring · required
Blood type of the student
Example: O+
birthDatestring · date-time · required
Birth date of the student
Example: 2025-01-23T10:00:00.000Z
gradestring · required
Grade level of the student
Example: 1
levelstring · required
School level of the student
Example: Primary
enrollmentstring · required
Enrollment number of the student
Example: 12345
firstNamestring · required
First name of the student
Example: John
lastNamestring · required
Last name of the student
Example: Doe
secondLastNamestring · required
Second last name of the user
Example: Smith
genrestring · required
Gender of the student
Example: FEMALE

POST /api/v1/student

curl --request POST \
  --url /api/v1/student \
  --header 'Content-Type: application/json' \
  --data '
{
  "bloodType": "O+",
  "birthDate": "2024-08-25T15:00:00Z",
  "grade": "1",
  "level": "Primary",
  "enrollment": "12345",
  "firstName": "John",
  "lastName": "Doe",
  "secondLastName": "Smith",
  "genre": "FEMALE",
  "familyId": 0
}
'

shell

Show example in

Request Body Example

{
  "bloodType": "O+",
  "birthDate": "2024-08-25T15:00:00Z",
  "grade": "1",
  "level": "Primary",
  "enrollment": "12345",
  "firstName": "John",
  "lastName": "Doe",
  "secondLastName": "Smith",
  "genre": "FEMALE",
  "familyId": 0
}

json

Example Responses

No example

json

application/json

Download students as Excel file

GET

/api/v1/student/download

Generate and download an Excel file with students data

Download students as Excel file › Responses

File download URL generated successfully

fileNamestring
Name of the generated file
urlstring
Signed S3 URL to download the file
expiresInnumber
URL expiration time in seconds

GET /api/v1/student/download

curl --request GET \
  --url /api/v1/student/download

shell

Show example in

Example Responses

No example

json

application/json

Get student by ID

GET

/api/v1/student/{id}

Retrieve a specific student by its ID

Get student by ID › path Parameters

idnumber · min: 1 · required
Id

Get student by ID › Responses

Student detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
bloodTypestring · required
Blood type of the student
Example: O+
birthDatestring · date-time · required
Birth date of the student
Example: 2025-01-23T10:00:00.000Z
gradestring · required
Grade level of the student
Example: 1
levelstring · required
School level of the student
Example: Primary
enrollmentstring · required
Enrollment number of the student
Example: 12345
firstNamestring · required
First name of the student
Example: John
lastNamestring · required
Last name of the student
Example: Doe
secondLastNamestring · required
Second last name of the user
Example: Smith
genrestring · required
Gender of the student
Example: FEMALE

GET /api/v1/student/{id}

curl --request GET \
  --url /api/v1/student/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a student

PUT

/api/v1/student/{id}

Update an existing student by its ID

Update a student › path Parameters

idnumber · min: 1 · required
Id

Update a student › Request Body

bloodTypestring
Blood type of the student
Example: O+
birthDatestring · date-time
Birth date of the student
Example: 2025-01-23T10:00:00.000Z
gradestring
Grade level of the student
Example: 1
levelstring
School level of the student
Example: Primary
enrollmentstring
Enrollment number of the student
Example: 12345
firstNamestring
First name of the student
Example: John
lastNamestring
Last name of the student
Example: Doe
secondLastNamestring
Second last name of the user
Example: Smith
genrestring
Gender of the student
Example: FEMALE

Update a student › Responses

Student updated

No data returned

PUT /api/v1/student/{id}

curl --request PUT \
  --url /api/v1/student/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "bloodType": "O+",
  "birthDate": "2024-08-25T15:00:00Z",
  "grade": "1",
  "level": "Primary",
  "enrollment": "12345",
  "firstName": "John",
  "lastName": "Doe",
  "secondLastName": "Smith",
  "genre": "FEMALE"
}
'

shell

Show example in

Request Body Example

{
  "bloodType": "O+",
  "birthDate": "2024-08-25T15:00:00Z",
  "grade": "1",
  "level": "Primary",
  "enrollment": "12345",
  "firstName": "John",
  "lastName": "Doe",
  "secondLastName": "Smith",
  "genre": "FEMALE"
}

json

Example Responses

No example

plain

Delete a student

DELETE

/api/v1/student/{id}

Delete a student by its ID

Delete a student › path Parameters

idnumber · min: 1 · required
Id

Delete a student › Responses

Student deleted

No data returned

Get student detail by ID

GET

/api/v1/student/{id}/detail

Retrieve detailed information about a specific student by its ID

Get student detail by ID › path Parameters

idnumber · min: 1 · required
Id

Get student detail by ID › Responses

Student detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
bloodTypestring · required
Blood type of the student
Example: O+
birthDatestring · date-time · required
Birth date of the student
Example: 2025-01-23T10:00:00.000Z
gradestring · required
Grade level of the student
Example: 1
levelstring · required
School level of the student
Example: Primary
enrollmentstring · required
Enrollment number of the student
Example: 12345
firstNamestring · required
First name of the student
Example: John
lastNamestring · required
Last name of the student
Example: Doe
secondLastNamestring · required
Second last name of the user
Example: Smith
genrestring · required
Gender of the student
Example: FEMALE

GET /api/v1/student/{id}/detail

curl --request GET \
  --url /api/v1/student/:id/detail

shell

Show example in

Example Responses

No example

json

application/json

Delete multiple students

POST

/api/v1/student/delete/bulk

Delete multiple students by their IDs

Delete multiple students › Request Body

idnumber · min: 1 · required
Id
Example: 1

Delete multiple students › Responses

Students deleted

No data returned

POST /api/v1/student/delete/bulk

curl --request POST \
  --url /api/v1/student/delete/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1
  }
]
'

shell

Show example in

Request Body Example

[
  {
    "id": 1
  }
]

json

Example Responses

No example

plain

Group Student Route Student

Brein API

Student

Get all students with filters

GET

/api/v1/student

Retrieve a paginated list of students based on query parameters and user role

Get all students with filters › query Parameters

routeIdnumber · required
Route id
hideDeletedboolean · required
Filter out deleted students
pagenumber
Current page
pageSizenumber
Page size
groupIdnumber
Group ID
keystring
Filter by multiples key
birthDateFromstring · date-time
Birth date of the student (from)
birthDateTostring · date-time
Birth date of the student (to)
ignoreGroupIdnumber
Ignore Group ID
gradesnumber[]
Grade list
levelsstring[]
Level list

Get all students with filters › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GET /api/v1/student

curl --request GET \
  --url '/api/v1/student?routeId=1&hideDeleted=true'

shell

Show example in

Example Responses

No example

json

application/json

Create a new student

POST

/api/v1/student

Create a new student with the provided data

Create a new student › Request Body

bloodTypestring · required
Blood type of the student
Example: O+
birthDatestring · date-time · required
Birth date of the student
Example: 2025-01-23T10:00:00.000Z
gradestring · required
Grade level of the student
Example: 1
levelstring · required
School level of the student
Example: Primary
enrollmentstring · required
Enrollment number of the student
Example: 12345
firstNamestring · required
First name of the student
Example: John
lastNamestring · required
Last name of the student
Example: Doe
secondLastNamestring · required
Second last name of the user
Example: Smith
genrestring · required
Gender of the student
Example: FEMALE

familyIdnumber
Family Id

Create a new student › Responses

Student created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
bloodTypestring · required
Blood type of the student
Example: O+
birthDatestring · date-time · required
Birth date of the student
Example: 2025-01-23T10:00:00.000Z
gradestring · required
Grade level of the student
Example: 1
levelstring · required
School level of the student
Example: Primary
enrollmentstring · required
Enrollment number of the student
Example: 12345
firstNamestring · required
First name of the student
Example: John
lastNamestring · required
Last name of the student
Example: Doe
secondLastNamestring · required
Second last name of the user
Example: Smith
genrestring · required
Gender of the student
Example: FEMALE

POST /api/v1/student

curl --request POST \
  --url /api/v1/student \
  --header 'Content-Type: application/json' \
  --data '
{
  "bloodType": "O+",
  "birthDate": "2024-08-25T15:00:00Z",
  "grade": "1",
  "level": "Primary",
  "enrollment": "12345",
  "firstName": "John",
  "lastName": "Doe",
  "secondLastName": "Smith",
  "genre": "FEMALE",
  "familyId": 0
}
'

shell

Show example in

Request Body Example

{
  "bloodType": "O+",
  "birthDate": "2024-08-25T15:00:00Z",
  "grade": "1",
  "level": "Primary",
  "enrollment": "12345",
  "firstName": "John",
  "lastName": "Doe",
  "secondLastName": "Smith",
  "genre": "FEMALE",
  "familyId": 0
}

json

Example Responses

No example

json

application/json

Download students as Excel file

GET

/api/v1/student/download

Generate and download an Excel file with students data

Download students as Excel file › Responses

File download URL generated successfully

fileNamestring
Name of the generated file
urlstring
Signed S3 URL to download the file
expiresInnumber
URL expiration time in seconds

GET /api/v1/student/download

curl --request GET \
  --url /api/v1/student/download

shell

Show example in

Example Responses

No example

json

application/json

Get student by ID

GET

/api/v1/student/{id}

Retrieve a specific student by its ID

Get student by ID › path Parameters

idnumber · min: 1 · required
Id

Get student by ID › Responses

Student detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
bloodTypestring · required
Blood type of the student
Example: O+
birthDatestring · date-time · required
Birth date of the student
Example: 2025-01-23T10:00:00.000Z
gradestring · required
Grade level of the student
Example: 1
levelstring · required
School level of the student
Example: Primary
enrollmentstring · required
Enrollment number of the student
Example: 12345
firstNamestring · required
First name of the student
Example: John
lastNamestring · required
Last name of the student
Example: Doe
secondLastNamestring · required
Second last name of the user
Example: Smith
genrestring · required
Gender of the student
Example: FEMALE

GET /api/v1/student/{id}

curl --request GET \
  --url /api/v1/student/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a student

PUT

/api/v1/student/{id}

Update an existing student by its ID

Update a student › path Parameters

idnumber · min: 1 · required
Id

Update a student › Request Body

bloodTypestring
Blood type of the student
Example: O+
birthDatestring · date-time
Birth date of the student
Example: 2025-01-23T10:00:00.000Z
gradestring
Grade level of the student
Example: 1
levelstring
School level of the student
Example: Primary
enrollmentstring
Enrollment number of the student
Example: 12345
firstNamestring
First name of the student
Example: John
lastNamestring
Last name of the student
Example: Doe
secondLastNamestring
Second last name of the user
Example: Smith
genrestring
Gender of the student
Example: FEMALE

Update a student › Responses

Student updated

No data returned

PUT /api/v1/student/{id}

curl --request PUT \
  --url /api/v1/student/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "bloodType": "O+",
  "birthDate": "2024-08-25T15:00:00Z",
  "grade": "1",
  "level": "Primary",
  "enrollment": "12345",
  "firstName": "John",
  "lastName": "Doe",
  "secondLastName": "Smith",
  "genre": "FEMALE"
}
'

shell

Show example in

Request Body Example

{
  "bloodType": "O+",
  "birthDate": "2024-08-25T15:00:00Z",
  "grade": "1",
  "level": "Primary",
  "enrollment": "12345",
  "firstName": "John",
  "lastName": "Doe",
  "secondLastName": "Smith",
  "genre": "FEMALE"
}

json

Example Responses

No example

plain

Delete a student

DELETE

/api/v1/student/{id}

Delete a student by its ID

Delete a student › path Parameters

idnumber · min: 1 · required
Id

Delete a student › Responses

Student deleted

No data returned

Get student detail by ID

GET

/api/v1/student/{id}/detail

Retrieve detailed information about a specific student by its ID

Get student detail by ID › path Parameters

idnumber · min: 1 · required
Id

Get student detail by ID › Responses

Student detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
bloodTypestring · required
Blood type of the student
Example: O+
birthDatestring · date-time · required
Birth date of the student
Example: 2025-01-23T10:00:00.000Z
gradestring · required
Grade level of the student
Example: 1
levelstring · required
School level of the student
Example: Primary
enrollmentstring · required
Enrollment number of the student
Example: 12345
firstNamestring · required
First name of the student
Example: John
lastNamestring · required
Last name of the student
Example: Doe
secondLastNamestring · required
Second last name of the user
Example: Smith
genrestring · required
Gender of the student
Example: FEMALE

GET /api/v1/student/{id}/detail

curl --request GET \
  --url /api/v1/student/:id/detail

shell

Show example in

Example Responses

No example

json

application/json

Delete multiple students

POST

/api/v1/student/delete/bulk

Delete multiple students by their IDs

Delete multiple students › Request Body

idnumber · min: 1 · required
Id
Example: 1

Delete multiple students › Responses

Students deleted

No data returned

POST /api/v1/student/delete/bulk

curl --request POST \
  --url /api/v1/student/delete/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1
  }
]
'

shell

Show example in

Request Body Example

[
  {
    "id": 1
  }
]

json

Example Responses

No example

plain

Group Student Route Student