Brein API

School Schedule

Get all school schedules with pagination

GET

/api/v1/school-schedule

Retrieve a paginated list of school schedules for the current school based on query parameters

Get all school schedules with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get all school schedules 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/school-schedule

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

shell

Show example in

Example Responses

No example

json

application/json

Create a new school schedule

POST

/api/v1/school-schedule

Create a new school schedule for the current school

Create a new school schedule › Request Body

namestring · required
Schedule name
entryTimestring · date-time · required
Entry time to the school
exitTimestring · date-time · required
Exit time from school
scheduleConfigurationobject · required
Schedule configuration for permissions

Create a new school schedule › Responses

SchoolSchedule created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Schedule name
entryTimestring · date-time · required
Entry time to the school
exitTimestring · date-time · required
Exit time from school
scheduleConfigurationobject · required
Schedule configuration for permissions

POST /api/v1/school-schedule

curl --request POST \
  --url /api/v1/school-schedule \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "entryTime": "2024-08-25T15:00:00Z",
  "exitTime": "2024-08-25T15:00:00Z",
  "scheduleConfiguration": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "permissionTimeLimit": 0,
    "permissionWeeksInAdvance": 1
  }
}
'

shell

Show example in

Request Body Example

{
  "name": "name",
  "entryTime": "2024-08-25T15:00:00Z",
  "exitTime": "2024-08-25T15:00:00Z",
  "scheduleConfiguration": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "permissionTimeLimit": 0,
    "permissionWeeksInAdvance": 1
  }
}

json

Example Responses

No example

json

application/json

Get school schedule by ID

GET

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

Retrieve a specific school schedule by its ID

Get school schedule by ID › path Parameters

idnumber · min: 1 · required
Id

Get school schedule by ID › Responses

SchoolSchedule detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Schedule name
entryTimestring · date-time · required
Entry time to the school
exitTimestring · date-time · required
Exit time from school
scheduleConfigurationobject · required
Schedule configuration for permissions

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

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

shell

Show example in

Example Responses

No example

json

application/json

Update a school schedule

PUT

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

Update an existing school schedule by its ID

Update a school schedule › path Parameters

idnumber · min: 1 · required
Id

Update a school schedule › Request Body

namestring
Schedule name
entryTimestring · date-time
Entry time to the school
exitTimestring · date-time
Exit time from school
scheduleConfigurationobject
Schedule configuration for permissions

Update a school schedule › Responses

SchoolSchedule updated

No data returned

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

curl --request PUT \
  --url /api/v1/school-schedule/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "entryTime": "2024-08-25T15:00:00Z",
  "exitTime": "2024-08-25T15:00:00Z",
  "scheduleConfiguration": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "permissionTimeLimit": 0,
    "permissionWeeksInAdvance": 1
  }
}
'

shell

Show example in

Request Body Example

{
  "name": "name",
  "entryTime": "2024-08-25T15:00:00Z",
  "exitTime": "2024-08-25T15:00:00Z",
  "scheduleConfiguration": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "permissionTimeLimit": 0,
    "permissionWeeksInAdvance": 1
  }
}

json

Example Responses

No example

plain

Delete a school schedule

DELETE

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

Delete a school schedule by its ID

Delete a school schedule › path Parameters

idnumber · min: 1 · required
Id

Delete a school schedule › Responses

SchoolSchedule deleted

No data returned

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

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

shell

Show example in

Example Responses

No example

plain

Route School Configuration

Brein API

School Schedule

Get all school schedules with pagination

GET

/api/v1/school-schedule

Retrieve a paginated list of school schedules for the current school based on query parameters

Get all school schedules with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get all school schedules 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/school-schedule

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

shell

Show example in

Example Responses

No example

json

application/json

Create a new school schedule

POST

/api/v1/school-schedule

Create a new school schedule for the current school

Create a new school schedule › Request Body

namestring · required
Schedule name
entryTimestring · date-time · required
Entry time to the school
exitTimestring · date-time · required
Exit time from school
scheduleConfigurationobject · required
Schedule configuration for permissions

Create a new school schedule › Responses

SchoolSchedule created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Schedule name
entryTimestring · date-time · required
Entry time to the school
exitTimestring · date-time · required
Exit time from school
scheduleConfigurationobject · required
Schedule configuration for permissions

POST /api/v1/school-schedule

curl --request POST \
  --url /api/v1/school-schedule \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "entryTime": "2024-08-25T15:00:00Z",
  "exitTime": "2024-08-25T15:00:00Z",
  "scheduleConfiguration": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "permissionTimeLimit": 0,
    "permissionWeeksInAdvance": 1
  }
}
'

shell

Show example in

Request Body Example

{
  "name": "name",
  "entryTime": "2024-08-25T15:00:00Z",
  "exitTime": "2024-08-25T15:00:00Z",
  "scheduleConfiguration": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "permissionTimeLimit": 0,
    "permissionWeeksInAdvance": 1
  }
}

json

Example Responses

No example

json

application/json

Get school schedule by ID

GET

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

Retrieve a specific school schedule by its ID

Get school schedule by ID › path Parameters

idnumber · min: 1 · required
Id

Get school schedule by ID › Responses

SchoolSchedule detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Schedule name
entryTimestring · date-time · required
Entry time to the school
exitTimestring · date-time · required
Exit time from school
scheduleConfigurationobject · required
Schedule configuration for permissions

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

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

shell

Show example in

Example Responses

No example

json

application/json

Update a school schedule

PUT

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

Update an existing school schedule by its ID

Update a school schedule › path Parameters

idnumber · min: 1 · required
Id

Update a school schedule › Request Body

namestring
Schedule name
entryTimestring · date-time
Entry time to the school
exitTimestring · date-time
Exit time from school
scheduleConfigurationobject
Schedule configuration for permissions

Update a school schedule › Responses

SchoolSchedule updated

No data returned

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

curl --request PUT \
  --url /api/v1/school-schedule/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "entryTime": "2024-08-25T15:00:00Z",
  "exitTime": "2024-08-25T15:00:00Z",
  "scheduleConfiguration": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "permissionTimeLimit": 0,
    "permissionWeeksInAdvance": 1
  }
}
'

shell

Show example in

Request Body Example

{
  "name": "name",
  "entryTime": "2024-08-25T15:00:00Z",
  "exitTime": "2024-08-25T15:00:00Z",
  "scheduleConfiguration": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "permissionTimeLimit": 0,
    "permissionWeeksInAdvance": 1
  }
}

json

Example Responses

No example

plain

Delete a school schedule

DELETE

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

Delete a school schedule by its ID

Delete a school schedule › path Parameters

idnumber · min: 1 · required
Id

Delete a school schedule › Responses

SchoolSchedule deleted

No data returned

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

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

shell

Show example in

Example Responses

No example

plain

Route School Configuration