Brein API

ScheduleConfiguration

Get schedule configurations for school

GET

/api/v1/schedule-configuration

Retrieve all schedule configurations for the current school

Get schedule configurations for school › 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/schedule-configuration

curl --request GET \
  --url /api/v1/schedule-configuration

shell

Show example in

Example Responses

No example

json

application/json

Create a new schedule configuration

POST

/api/v1/schedule-configuration

Create a new schedule configuration for the current school

Create a new schedule configuration › Request Body

permissionTimeLimitnumber · required
Number of hours in advance required to request permission
permissionWeeksInAdvancenumber · enum · required
Weeks in advance for receiving permissions
Enum values:
1
2
3
4
Example: 1

Create a new schedule configuration › Responses

ScheduleConfiguration created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
permissionTimeLimitnumber · required
Number of hours in advance required to request permission
permissionWeeksInAdvancenumber · enum · required
Weeks in advance for receiving permissions
Enum values:
1
2
3
4
Example: 1

POST /api/v1/schedule-configuration

curl --request POST \
  --url /api/v1/schedule-configuration \
  --header 'Content-Type: application/json' \
  --data '
{
  "permissionTimeLimit": 0,
  "permissionWeeksInAdvance": 1
}
'

shell

Show example in

Request Body Example

{
  "permissionTimeLimit": 0,
  "permissionWeeksInAdvance": 1
}

json

Example Responses

No example

json

application/json

Get schedule configuration by ID

GET

/api/v1/schedule-configuration/{id}

Retrieve a specific schedule configuration by its ID

Get schedule configuration by ID › path Parameters

idnumber · min: 1 · required
Id

Get schedule configuration by ID › Responses

ScheduleConfiguration detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
permissionTimeLimitnumber · required
Number of hours in advance required to request permission
permissionWeeksInAdvancenumber · enum · required
Weeks in advance for receiving permissions
Enum values:
1
2
3
4
Example: 1

GET /api/v1/schedule-configuration/{id}

curl --request GET \
  --url /api/v1/schedule-configuration/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a schedule configuration

PUT

/api/v1/schedule-configuration/{id}

Update an existing schedule configuration by its ID

Update a schedule configuration › path Parameters

idnumber · min: 1 · required
Id

Update a schedule configuration › Request Body

permissionTimeLimitnumber
Number of hours in advance required to request permission
permissionWeeksInAdvancenumber · enum
Weeks in advance for receiving permissions
Enum values:
1
2
3
4
Example: 1

Update a schedule configuration › Responses

ScheduleConfiguration updated

No data returned

PUT /api/v1/schedule-configuration/{id}

curl --request PUT \
  --url /api/v1/schedule-configuration/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "permissionTimeLimit": 0,
  "permissionWeeksInAdvance": 1
}
'

shell

Show example in

Request Body Example

{
  "permissionTimeLimit": 0,
  "permissionWeeksInAdvance": 1
}

json

Example Responses

No example

plain

Delete a schedule configuration

DELETE

/api/v1/schedule-configuration/{id}

Delete a schedule configuration by its ID

Delete a schedule configuration › path Parameters

idnumber · min: 1 · required
Id

Delete a schedule configuration › Responses

ScheduleConfiguration deleted

No data returned

DELETE /api/v1/schedule-configuration/{id}

curl --request DELETE \
  --url /api/v1/schedule-configuration/:id

shell

Show example in

Example Responses

No example

plain

Event reminder Invitation Student Responses

Brein API

ScheduleConfiguration

Get schedule configurations for school

GET

/api/v1/schedule-configuration

Retrieve all schedule configurations for the current school

Get schedule configurations for school › 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/schedule-configuration

curl --request GET \
  --url /api/v1/schedule-configuration

shell

Show example in

Example Responses

No example

json

application/json

Create a new schedule configuration

POST

/api/v1/schedule-configuration

Create a new schedule configuration for the current school

Create a new schedule configuration › Request Body

permissionTimeLimitnumber · required
Number of hours in advance required to request permission
permissionWeeksInAdvancenumber · enum · required
Weeks in advance for receiving permissions
Enum values:
1
2
3
4
Example: 1

Create a new schedule configuration › Responses

ScheduleConfiguration created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
permissionTimeLimitnumber · required
Number of hours in advance required to request permission
permissionWeeksInAdvancenumber · enum · required
Weeks in advance for receiving permissions
Enum values:
1
2
3
4
Example: 1

POST /api/v1/schedule-configuration

curl --request POST \
  --url /api/v1/schedule-configuration \
  --header 'Content-Type: application/json' \
  --data '
{
  "permissionTimeLimit": 0,
  "permissionWeeksInAdvance": 1
}
'

shell

Show example in

Request Body Example

{
  "permissionTimeLimit": 0,
  "permissionWeeksInAdvance": 1
}

json

Example Responses

No example

json

application/json

Get schedule configuration by ID

GET

/api/v1/schedule-configuration/{id}

Retrieve a specific schedule configuration by its ID

Get schedule configuration by ID › path Parameters

idnumber · min: 1 · required
Id

Get schedule configuration by ID › Responses

ScheduleConfiguration detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
permissionTimeLimitnumber · required
Number of hours in advance required to request permission
permissionWeeksInAdvancenumber · enum · required
Weeks in advance for receiving permissions
Enum values:
1
2
3
4
Example: 1

GET /api/v1/schedule-configuration/{id}

curl --request GET \
  --url /api/v1/schedule-configuration/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a schedule configuration

PUT

/api/v1/schedule-configuration/{id}

Update an existing schedule configuration by its ID

Update a schedule configuration › path Parameters

idnumber · min: 1 · required
Id

Update a schedule configuration › Request Body

permissionTimeLimitnumber
Number of hours in advance required to request permission
permissionWeeksInAdvancenumber · enum
Weeks in advance for receiving permissions
Enum values:
1
2
3
4
Example: 1

Update a schedule configuration › Responses

ScheduleConfiguration updated

No data returned

PUT /api/v1/schedule-configuration/{id}

curl --request PUT \
  --url /api/v1/schedule-configuration/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "permissionTimeLimit": 0,
  "permissionWeeksInAdvance": 1
}
'

shell

Show example in

Request Body Example

{
  "permissionTimeLimit": 0,
  "permissionWeeksInAdvance": 1
}

json

Example Responses

No example

plain

Delete a schedule configuration

DELETE

/api/v1/schedule-configuration/{id}

Delete a schedule configuration by its ID

Delete a schedule configuration › path Parameters

idnumber · min: 1 · required
Id

Delete a schedule configuration › Responses

ScheduleConfiguration deleted

No data returned

DELETE /api/v1/schedule-configuration/{id}

curl --request DELETE \
  --url /api/v1/schedule-configuration/:id

shell

Show example in

Example Responses

No example

plain

Event reminder Invitation Student Responses