Get all school configurations with pagination
Retrieve a paginated list of school configurations based on query parameters
query Parameters
pagenumberCurrent page
pageSizenumberPage size
Responses
dataobject[] · requiredData
pagenumberCurrent page
pageSizenumberPage size
totalnumberTotal
lastPagenumberLast page
nextstringNext page (endpoint)
previousstringPrevious page (endpoint)
Create a new school configuration
Create a new school configuration for the current school
Request Body
limitExitPermissionnumber · requiredHours in advance required for exit permission requests
Example: 24startCyclestring · date-time · requiredStart date of the school cycle
Example: 2025-01-14T01:14:37.659ZendCyclestring · date-time · requiredEnd date of the school cycle
Example: 2025-01-14T01:14:37.659ZentryTimestring · requiredEntry time to the school
Example: 08:00:00regularExitTimestring · requiredRegular exit time from school
Example: 14:00:00customExitTimestring · requiredCustom exit time from school for specific cases
Example: 16:00:00showFamilyPhoneNumberboolean · requiredShow family phone number in the exit permission form
Example: trueshowFamilyEmailboolean · requiredShow family email in the exit permission form
Example: trueholidayCyclesobject[] · requiredHolidays
Responses
School Configuration created
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
limitExitPermissionnumber · requiredHours in advance required for exit permission requests
Example: 24startCyclestring · date-time · requiredStart date of the school cycle
Example: 2025-01-14T01:14:37.659ZendCyclestring · date-time · requiredEnd date of the school cycle
Example: 2025-01-14T01:14:37.659ZentryTimestring · requiredEntry time to the school
Example: 08:00:00regularExitTimestring · requiredRegular exit time from school
Example: 14:00:00customExitTimestring · requiredCustom exit time from school for specific cases
Example: 16:00:00showFamilyPhoneNumberboolean · requiredShow family phone number in the exit permission form
Example: trueshowFamilyEmailboolean · requiredShow family email in the exit permission form
Example: true
Get school configuration by ID
Retrieve a specific school configuration by its ID
path Parameters
idnumber · min: 1 · requiredId
Responses
School Configuration detail
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
limitExitPermissionnumber · requiredHours in advance required for exit permission requests
Example: 24startCyclestring · date-time · requiredStart date of the school cycle
Example: 2025-01-14T01:14:37.659ZendCyclestring · date-time · requiredEnd date of the school cycle
Example: 2025-01-14T01:14:37.659ZentryTimestring · requiredEntry time to the school
Example: 08:00:00regularExitTimestring · requiredRegular exit time from school
Example: 14:00:00customExitTimestring · requiredCustom exit time from school for specific cases
Example: 16:00:00showFamilyPhoneNumberboolean · requiredShow family phone number in the exit permission form
Example: trueshowFamilyEmailboolean · requiredShow family email in the exit permission form
Example: true
Update a school configuration
Update an existing school configuration by its ID
path Parameters
idnumber · min: 1 · requiredId
Request Body
limitExitPermissionnumberHours in advance required for exit permission requests
Example: 24startCyclestring · date-timeStart date of the school cycle
Example: 2025-01-14T01:14:37.659ZendCyclestring · date-timeEnd date of the school cycle
Example: 2025-01-14T01:14:37.659ZentryTimestringEntry time to the school
Example: 08:00:00regularExitTimestringRegular exit time from school
Example: 14:00:00customExitTimestringCustom exit time from school for specific cases
Example: 16:00:00showFamilyPhoneNumberbooleanShow family phone number in the exit permission form
Example: trueshowFamilyEmailbooleanShow family email in the exit permission form
Example: trueholidayCyclesobject[]Holidays
Responses
School Configuration updated