Brein API

School Holiday Cycle

Get all school holiday cycles with pagination

GET

/api/v1/school-holiday-cycle

Retrieve a paginated list of school holiday cycles based on query parameters

Get all school holiday cycles with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get all school holiday cycles 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-holiday-cycle

curl --request GET \
  --url /api/v1/school-holiday-cycle

shell

Show example in

Example Responses

No example

json

application/json

Create a new school holiday cycle

POST

/api/v1/school-holiday-cycle

Create a new school holiday cycle with the provided data

Create a new school holiday cycle › Request Body

startHolidaysstring · date-time · required
Start date of the holidays
Example: 2025-01-14T01:14:37.659Z
endHolidaysstring · date-time · required
End date of the holidays
Example: 2025-01-14T01:14:37.659Z
schoolConfigurationIdnumber · min: 1 · required
School Configuration id
Example: 1

Create a new school holiday cycle › Responses

SchoolHolidayCycle created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
startHolidaysstring · date-time · required
Start date of the holidays
Example: 2025-01-14T01:14:37.659Z
endHolidaysstring · date-time · required
End date of the holidays
Example: 2025-01-14T01:14:37.659Z

POST /api/v1/school-holiday-cycle

curl --request POST \
  --url /api/v1/school-holiday-cycle \
  --header 'Content-Type: application/json' \
  --data '
{
  "startHolidays": "2024-08-25T15:00:00Z",
  "endHolidays": "2024-08-25T15:00:00Z",
  "schoolConfigurationId": 1
}
'

shell

Show example in

Request Body Example

{
  "startHolidays": "2024-08-25T15:00:00Z",
  "endHolidays": "2024-08-25T15:00:00Z",
  "schoolConfigurationId": 1
}

json

Example Responses

No example

json

application/json

Get school holiday cycle by ID

GET

/api/v1/school-holiday-cycle/{id}

Retrieve a specific school holiday cycle by its ID

Get school holiday cycle by ID › path Parameters

idnumber · min: 1 · required
Id

Get school holiday cycle by ID › Responses

SchoolHolidayCycle detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
startHolidaysstring · date-time · required
Start date of the holidays
Example: 2025-01-14T01:14:37.659Z
endHolidaysstring · date-time · required
End date of the holidays
Example: 2025-01-14T01:14:37.659Z

GET /api/v1/school-holiday-cycle/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a school holiday cycle

PUT

/api/v1/school-holiday-cycle/{id}

Update an existing school holiday cycle by its ID

Update a school holiday cycle › path Parameters

idnumber · min: 1 · required
Id

Update a school holiday cycle › Request Body

startHolidaysstring · date-time
Start date of the holidays
Example: 2025-01-14T01:14:37.659Z
endHolidaysstring · date-time
End date of the holidays
Example: 2025-01-14T01:14:37.659Z

Update a school holiday cycle › Responses

SchoolHolidayCycle updated

No data returned

PUT /api/v1/school-holiday-cycle/{id}

curl --request PUT \
  --url /api/v1/school-holiday-cycle/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "startHolidays": "2024-08-25T15:00:00Z",
  "endHolidays": "2024-08-25T15:00:00Z"
}
'

shell

Show example in

Request Body Example

{
  "startHolidays": "2024-08-25T15:00:00Z",
  "endHolidays": "2024-08-25T15:00:00Z"
}

json

Example Responses

No example

plain

Delete a school holiday cycle

DELETE

/api/v1/school-holiday-cycle/{id}

Delete a school holiday cycle by its ID

Delete a school holiday cycle › path Parameters

idnumber · min: 1 · required
Id

Delete a school holiday cycle › Responses

SchoolHolidayCycle deleted

No data returned

DELETE /api/v1/school-holiday-cycle/{id}

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

shell

Show example in

Example Responses

No example

plain

School Configuration Transport

Brein API

School Holiday Cycle

Get all school holiday cycles with pagination

GET

/api/v1/school-holiday-cycle

Retrieve a paginated list of school holiday cycles based on query parameters

Get all school holiday cycles with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get all school holiday cycles 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-holiday-cycle

curl --request GET \
  --url /api/v1/school-holiday-cycle

shell

Show example in

Example Responses

No example

json

application/json

Create a new school holiday cycle

POST

/api/v1/school-holiday-cycle

Create a new school holiday cycle with the provided data

Create a new school holiday cycle › Request Body

startHolidaysstring · date-time · required
Start date of the holidays
Example: 2025-01-14T01:14:37.659Z
endHolidaysstring · date-time · required
End date of the holidays
Example: 2025-01-14T01:14:37.659Z
schoolConfigurationIdnumber · min: 1 · required
School Configuration id
Example: 1

Create a new school holiday cycle › Responses

SchoolHolidayCycle created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
startHolidaysstring · date-time · required
Start date of the holidays
Example: 2025-01-14T01:14:37.659Z
endHolidaysstring · date-time · required
End date of the holidays
Example: 2025-01-14T01:14:37.659Z

POST /api/v1/school-holiday-cycle

curl --request POST \
  --url /api/v1/school-holiday-cycle \
  --header 'Content-Type: application/json' \
  --data '
{
  "startHolidays": "2024-08-25T15:00:00Z",
  "endHolidays": "2024-08-25T15:00:00Z",
  "schoolConfigurationId": 1
}
'

shell

Show example in

Request Body Example

{
  "startHolidays": "2024-08-25T15:00:00Z",
  "endHolidays": "2024-08-25T15:00:00Z",
  "schoolConfigurationId": 1
}

json

Example Responses

No example

json

application/json

Get school holiday cycle by ID

GET

/api/v1/school-holiday-cycle/{id}

Retrieve a specific school holiday cycle by its ID

Get school holiday cycle by ID › path Parameters

idnumber · min: 1 · required
Id

Get school holiday cycle by ID › Responses

SchoolHolidayCycle detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
startHolidaysstring · date-time · required
Start date of the holidays
Example: 2025-01-14T01:14:37.659Z
endHolidaysstring · date-time · required
End date of the holidays
Example: 2025-01-14T01:14:37.659Z

GET /api/v1/school-holiday-cycle/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a school holiday cycle

PUT

/api/v1/school-holiday-cycle/{id}

Update an existing school holiday cycle by its ID

Update a school holiday cycle › path Parameters

idnumber · min: 1 · required
Id

Update a school holiday cycle › Request Body

startHolidaysstring · date-time
Start date of the holidays
Example: 2025-01-14T01:14:37.659Z
endHolidaysstring · date-time
End date of the holidays
Example: 2025-01-14T01:14:37.659Z

Update a school holiday cycle › Responses

SchoolHolidayCycle updated

No data returned

PUT /api/v1/school-holiday-cycle/{id}

curl --request PUT \
  --url /api/v1/school-holiday-cycle/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "startHolidays": "2024-08-25T15:00:00Z",
  "endHolidays": "2024-08-25T15:00:00Z"
}
'

shell

Show example in

Request Body Example

{
  "startHolidays": "2024-08-25T15:00:00Z",
  "endHolidays": "2024-08-25T15:00:00Z"
}

json

Example Responses

No example

plain

Delete a school holiday cycle

DELETE

/api/v1/school-holiday-cycle/{id}

Delete a school holiday cycle by its ID

Delete a school holiday cycle › path Parameters

idnumber · min: 1 · required
Id

Delete a school holiday cycle › Responses

SchoolHolidayCycle deleted

No data returned

DELETE /api/v1/school-holiday-cycle/{id}

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

shell

Show example in

Example Responses

No example

plain

School Configuration Transport