Brein API

Group Student

Get all group-student associations with pagination

GET

/api/v1/group-student

Retrieve a paginated list of group-student associations based on query parameters

Get all group-student associations with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
dummystring
Dummy filter

Get all group-student associations with pagination › 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-student

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

shell

Show example in

Example Responses

No example

json

application/json

Create a group-student association

POST

/api/v1/group-student

Create a new association between a group and a student

Create a group-student association › Request Body

Create a group-student association › Responses

GroupStudent created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

POST /api/v1/group-student

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

shell

Show example in

Request Body Example

{}

json

Example Responses

No example

json

application/json

Get group-student association by ID

GET

/api/v1/group-student/{id}

Retrieve a specific group-student association by its ID

Get group-student association by ID › path Parameters

idnumber · min: 1 · required
Id

Get group-student association by ID › Responses

GroupStudent detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

GET /api/v1/group-student/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a group-student association

PUT

/api/v1/group-student/{id}

Update an existing group-student association by its ID

Update a group-student association › path Parameters

idnumber · min: 1 · required
Id

Update a group-student association › Request Body

Update a group-student association › Responses

GroupStudent updated

No data returned

PUT /api/v1/group-student/{id}

curl --request PUT \
  --url /api/v1/group-student/:id \
  --header 'Content-Type: application/json' \
  --data '{}'

shell

Show example in

Request Body Example

{}

json

Example Responses

No example

plain

Delete a group-student association

DELETE

/api/v1/group-student/{id}

Delete a group-student association by its ID

Delete a group-student association › path Parameters

idnumber · min: 1 · required
Id

Delete a group-student association › Responses

GroupStudent deleted

No data returned

DELETE /api/v1/group-student/{id}

curl --request DELETE \
  --url /api/v1/group-student/:id

shell

Show example in

Example Responses

No example

plain

Group Teacher Student

Brein API

Group Student

Get all group-student associations with pagination

GET

/api/v1/group-student

Retrieve a paginated list of group-student associations based on query parameters

Get all group-student associations with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
dummystring
Dummy filter

Get all group-student associations with pagination › 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-student

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

shell

Show example in

Example Responses

No example

json

application/json

Create a group-student association

POST

/api/v1/group-student

Create a new association between a group and a student

Create a group-student association › Request Body

Create a group-student association › Responses

GroupStudent created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

POST /api/v1/group-student

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

shell

Show example in

Request Body Example

{}

json

Example Responses

No example

json

application/json

Get group-student association by ID

GET

/api/v1/group-student/{id}

Retrieve a specific group-student association by its ID

Get group-student association by ID › path Parameters

idnumber · min: 1 · required
Id

Get group-student association by ID › Responses

GroupStudent detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

GET /api/v1/group-student/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a group-student association

PUT

/api/v1/group-student/{id}

Update an existing group-student association by its ID

Update a group-student association › path Parameters

idnumber · min: 1 · required
Id

Update a group-student association › Request Body

Update a group-student association › Responses

GroupStudent updated

No data returned

PUT /api/v1/group-student/{id}

curl --request PUT \
  --url /api/v1/group-student/:id \
  --header 'Content-Type: application/json' \
  --data '{}'

shell

Show example in

Request Body Example

{}

json

Example Responses

No example

plain

Delete a group-student association

DELETE

/api/v1/group-student/{id}

Delete a group-student association by its ID

Delete a group-student association › path Parameters

idnumber · min: 1 · required
Id

Delete a group-student association › Responses

GroupStudent deleted

No data returned

DELETE /api/v1/group-student/{id}

curl --request DELETE \
  --url /api/v1/group-student/:id

shell

Show example in

Example Responses

No example

plain

Group Teacher Student