Brein API

Group

Get all groups with filters

GET

/api/v1/group

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

Get all groups with filters › query Parameters

schoolIdnumber · min: 1 · required
School id
miniboolean · required
Task archived?
pagenumber
Current page
pageSizenumber
Page size
keystring
Filter by multiples key
cyclestring
Cycle filter
gradesnumber[]
List of grades
levelsstring[]
Levels

Get all groups 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/group

curl --request GET \
  --url '/api/v1/group?schoolId=1&mini=%3Cbool%3E'

shell

Show example in

Example Responses

No example

json

application/json

Create a new group

POST

/api/v1/group

Create a new group with the provided data

Create a new group › Request Body

startCyclestring · date-time · required
Start cycle associated with the group
endCyclestring · date-time · required
End cycle associated with the group
levelstring · required
Level of the group
Example: High School
gradesstring[] · required
Grade of the group
Example: 12th Grade
namestring · required
Name of the group
Example: Group A
descriptionstring · required
Description of the group
Example: Group A Description
slugImgstring · required
Slug of the group image
Example: /slug-school/1-group.png

Create a new group › Responses

Group created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
startCyclestring · date-time · required
Start cycle associated with the group
endCyclestring · date-time · required
End cycle associated with the group
levelstring · required
Level of the group
Example: High School
gradesstring[] · required
Grade of the group
Example: 12th Grade
namestring · required
Name of the group
Example: Group A
descriptionstring · required
Description of the group
Example: Group A Description
slugImgstring · required
Slug of the group image
Example: /slug-school/1-group.png

POST /api/v1/group

curl --request POST \
  --url /api/v1/group \
  --header 'Content-Type: application/json' \
  --data '
{
  "startCycle": "2024-08-25T15:00:00Z",
  "endCycle": "2024-08-25T15:00:00Z",
  "level": "High School",
  "grades": [
    "string"
  ],
  "name": "Group A",
  "description": "Group A Description",
  "slugImg": "/slug-school/1-group.png"
}
'

shell

Show example in

Request Body Example

{
  "startCycle": "2024-08-25T15:00:00Z",
  "endCycle": "2024-08-25T15:00:00Z",
  "level": "High School",
  "grades": [
    "string"
  ],
  "name": "Group A",
  "description": "Group A Description",
  "slugImg": "/slug-school/1-group.png"
}

json

Example Responses

No example

json

application/json

Get groups for the current user

GET

/api/v1/group/me

Retrieve all groups associated with the current user based on their role

Get groups for the current user › query Parameters

schoolIdnumber · min: 1 · required
School id
miniboolean · required
Task archived?
pagenumber
Current page
pageSizenumber
Page size
keystring
Filter by multiples key
cyclestring
Cycle filter
gradesnumber[]
List of grades
levelsstring[]
Levels

Get groups for the current user › 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/group/me

curl --request GET \
  --url '/api/v1/group/me?schoolId=1&mini=%3Cbool%3E'

shell

Show example in

Example Responses

No example

json

application/json

Get participants of group

GET

/api/v1/group/{id}/participants

Get participants of group

Get participants of group › path Parameters

idnumber · min: 1 · required
Id

Get participants of group › query Parameters

schoolIdnumber · min: 1 · required
School id
pagenumber
Current page
pageSizenumber
Page size
keystring
Filter by multiples key
rolesstring[]
Role list
gradesnumber[]
Grade list
levelsstring[]
Level list

Get participants of group › Responses

schoolIdnumber · min: 1 · required
School id
Example: 1

pagenumber
Current page
pageSizenumber
Page size
keystring
Filter by multiples key
rolesstring[]
Role list
gradesnumber[]
Grade list
levelsstring[]
Level list

GET /api/v1/group/{id}/participants

curl --request GET \
  --url '/api/v1/group/:id/participants?schoolId=1'

shell

Show example in

Example Responses

No example

json

application/json

Remove participants from group

DELETE

/api/v1/group/{id}/participants

Remove participants from group

Remove participants from group › path Parameters

idnumber · min: 1 · required
Id

Remove participants from group › Request Body

studentIdsnumber[] · required
Student list of Ids
teacherIdsnumber[] · required
Teacher list of Ids

Remove participants from group › Responses

No data returned

DELETE /api/v1/group/{id}/participants

curl --request DELETE \
  --url /api/v1/group/:id/participants \
  --header 'Content-Type: application/json' \
  --data '
{
  "studentIds": [
    0
  ],
  "teacherIds": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "studentIds": [
    0
  ],
  "teacherIds": [
    0
  ]
}

json

Example Responses

No example

plain

Add participants of group

PUT

/api/v1/group/{id}/participants/add

Add participants to group

Add participants of group › path Parameters

idnumber · min: 1 · required
Id

Add participants of group › Request Body

studentIdsnumber[] · required
Student list of Ids
teacherIdsnumber[] · required
Teacher list of Ids

Add participants of group › Responses

No data returned

PUT /api/v1/group/{id}/participants/add

curl --request PUT \
  --url /api/v1/group/:id/participants/add \
  --header 'Content-Type: application/json' \
  --data '
{
  "studentIds": [
    0
  ],
  "teacherIds": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "studentIds": [
    0
  ],
  "teacherIds": [
    0
  ]
}

json

Example Responses

No example

plain

Get group by ID

GET

/api/v1/group/{id}

Retrieve a specific group by its ID

Get group by ID › path Parameters

idnumber · min: 1 · required
Id

Get group by ID › Responses

Group detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
startCyclestring · date-time · required
Start cycle associated with the group
endCyclestring · date-time · required
End cycle associated with the group
levelstring · required
Level of the group
Example: High School
gradesstring[] · required
Grade of the group
Example: 12th Grade
namestring · required
Name of the group
Example: Group A
descriptionstring · required
Description of the group
Example: Group A Description
slugImgstring · required
Slug of the group image
Example: /slug-school/1-group.png

Update a group

PUT

/api/v1/group/{id}

Update an existing group by its ID

Update a group › path Parameters

idnumber · min: 1 · required
Id

Update a group › Request Body

startCyclestring · date-time
Start cycle associated with the group
endCyclestring · date-time
End cycle associated with the group
levelstring
Level of the group
Example: High School
gradesstring[]
Grade of the group
Example: 12th Grade
namestring
Name of the group
Example: Group A
descriptionstring
Description of the group
Example: Group A Description
slugImgstring
Slug of the group image
Example: /slug-school/1-group.png

Update a group › Responses

Group updated

No data returned

PUT /api/v1/group/{id}

curl --request PUT \
  --url /api/v1/group/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "startCycle": "2024-08-25T15:00:00Z",
  "endCycle": "2024-08-25T15:00:00Z",
  "level": "High School",
  "grades": [
    "string"
  ],
  "name": "Group A",
  "description": "Group A Description",
  "slugImg": "/slug-school/1-group.png"
}
'

shell

Show example in

Request Body Example

{
  "startCycle": "2024-08-25T15:00:00Z",
  "endCycle": "2024-08-25T15:00:00Z",
  "level": "High School",
  "grades": [
    "string"
  ],
  "name": "Group A",
  "description": "Group A Description",
  "slugImg": "/slug-school/1-group.png"
}

json

Example Responses

No example

plain

Delete a group

DELETE

/api/v1/group/{id}

Delete a group by its ID

Delete a group › path Parameters

idnumber · min: 1 · required
Id

Delete a group › Responses

Group deleted

No data returned

Upload file with groups

POST

/api/v1/group/bulk

Upload file with groups › Request Body

filestring

Upload file with groups › Responses

No data returned

POST /api/v1/group/bulk

curl --request POST \
  --url /api/v1/group/bulk \
  --header 'Content-Type: application/json' \
  --data '{
  "file": "file"
}'

shell

Show example in

Request Body Example

{
  "file": "file"
}

json

Example Responses

No example

plain

Delete multiple groups

DELETE

/api/v1/group/bulk

Delete multiple groups by their IDs

Delete multiple groups › Request Body

idsnumber[] · required
Group list of Ids

Delete multiple groups › Responses

Groups deleted

No data returned

DELETE /api/v1/group/bulk

curl --request DELETE \
  --url /api/v1/group/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "ids": [
    0
  ]
}

json

Example Responses

No example

plain

Generate signed URL for group

PUT

/api/v1/group/{id}/signed-url

Generate a signed URL for accessing group resources

Generate signed URL for group › path Parameters

idnumber · min: 1 · required
Id

Generate signed URL for group › Request Body

methodstring · required
Method of request (GET | PUT)
Example: GET
contentTypestring · required
Content type of de image
Example: image/webp

Generate signed URL for group › Responses

No data returned

PUT /api/v1/group/{id}/signed-url

curl --request PUT \
  --url /api/v1/group/:id/signed-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "GET",
  "contentType": "image/webp"
}
'

shell

Show example in

Request Body Example

{
  "method": "GET",
  "contentType": "image/webp"
}

json

Example Responses

No example

plain

Send notification to group members

POST

/api/v1/group/notify/post

Send notification to group members

Send notification to group members › Request Body

groupIdsnumber[] · required
Array of group IDs to send notifications to
Example: [1,2,3]

Send notification to group members › Responses

Notification sent successfully

messagestring · required
Success message
Example: Notifications sent successfully
notificationsSentnumber · required
Number of notifications sent
Example: 10

POST /api/v1/group/notify/post

curl --request POST \
  --url /api/v1/group/notify/post \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupIds": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "groupIds": [
    0
  ]
}

json

Example Responses

No example

json

application/json

Delegates Group Teacher