Get all route availabilities with pagination
Retrieve a paginated list of route availabilities based on query parameters
query Parameters
pagenumberCurrent page
pageSizenumberPage size
routeIdnumberRoute ID filter
datestring · date-timeDate filter (YYYY-MM-DD)
fromDatestring · date-timeFrom date filter (YYYY-MM-DD)
toDatestring · date-timeTo date filter (YYYY-MM-DD)
Responses
dataobject[] · requiredData
pagenumberCurrent page
pageSizenumberPage size
totalnumberTotal
lastPagenumberLast page
nextstringNext page (endpoint)
previousstringPrevious page (endpoint)
Create a new route availability
Create a new route availability with the provided data
Request Body
schoolobject · requiredSchool
routeobject · requiredRoute
datestring · date-time · requiredDate for availability tracking
totalCapacitynumber · requiredTotal capacity of the transport unit
totalRequestednumber · requiredTotal seats requested (pending + approved permissions and invitations)
totalAvailablenumber · requiredTotal available seats
totalRejectednumber · requiredTotal rejected seats
totalAssignednumber · requiredTotal assigned seats (approved permissions and invitations)
totalPendingnumber · requiredTotal pending requests (pending permissions and invitations)
Responses
RouteAvailability created
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
schoolobject · requiredSchool
routeobject · requiredRoute
datestring · date-time · requiredDate for availability tracking
totalCapacitynumber · requiredTotal capacity of the transport unit
totalRequestednumber · requiredTotal seats requested (pending + approved permissions and invitations)
totalAvailablenumber · requiredTotal available seats
totalRejectednumber · requiredTotal rejected seats
totalAssignednumber · requiredTotal assigned seats (approved permissions and invitations)
totalPendingnumber · requiredTotal pending requests (pending permissions and invitations)
Get route availability for school
Retrieve route availability information for a school on a specific date
query Parameters
datestring · date-time · requiredDate (YYYY-MM-DD)
pagenumberCurrent page
pageSizenumberPage size
Responses
Route availability for school and date
dataobject[] · requiredData
pagenumberCurrent page
pageSizenumberPage size
totalnumberTotal
lastPagenumberLast page
nextstringNext page (endpoint)
previousstringPrevious page (endpoint)
Get route availability by route ID
Retrieve route availability details for a specific route on a specific date
path Parameters
routeIdnumber · requiredRoute ID
query Parameters
datestring · date-time · requiredDate (YYYY-MM-DD)
Responses
Route availability details
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
schoolobject · requiredSchool
routeobject · requiredRoute
datestring · date-time · requiredDate for availability tracking
totalCapacitynumber · requiredTotal capacity of the transport unit
totalRequestednumber · requiredTotal seats requested (pending + approved permissions and invitations)
totalAvailablenumber · requiredTotal available seats
totalRejectednumber · requiredTotal rejected seats
totalAssignednumber · requiredTotal assigned seats (approved permissions and invitations)
totalPendingnumber · requiredTotal pending requests (pending permissions and invitations)
Get route availability history for school
Retrieve route availability history for a school within a date range
query Parameters
fromDatestring · date-time · requiredFrom date (YYYY-MM-DD)
toDatestring · date-time · requiredTo date (YYYY-MM-DD)
Responses
Route availability history for school and date range
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
schoolobject · requiredSchool
routeobject · requiredRoute
datestring · date-time · requiredDate for availability tracking
totalCapacitynumber · requiredTotal capacity of the transport unit
totalRequestednumber · requiredTotal seats requested (pending + approved permissions and invitations)
totalAvailablenumber · requiredTotal available seats
totalRejectednumber · requiredTotal rejected seats
totalAssignednumber · requiredTotal assigned seats (approved permissions and invitations)
totalPendingnumber · requiredTotal pending requests (pending permissions and invitations)
Get route availability by ID
Retrieve a specific route availability by its ID
path Parameters
idnumber · min: 1 · requiredId
Responses
RouteAvailability detail
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
schoolobject · requiredSchool
routeobject · requiredRoute
datestring · date-time · requiredDate for availability tracking
totalCapacitynumber · requiredTotal capacity of the transport unit
totalRequestednumber · requiredTotal seats requested (pending + approved permissions and invitations)
totalAvailablenumber · requiredTotal available seats
totalRejectednumber · requiredTotal rejected seats
totalAssignednumber · requiredTotal assigned seats (approved permissions and invitations)
totalPendingnumber · requiredTotal pending requests (pending permissions and invitations)
Update a route availability
Update an existing route availability by its ID
path Parameters
idnumber · min: 1 · requiredId
Request Body
schoolobjectSchool
routeobjectRoute
datestring · date-timeDate for availability tracking
totalCapacitynumberTotal capacity of the transport unit
totalRequestednumberTotal seats requested (pending + approved permissions and invitations)
totalAvailablenumberTotal available seats
totalRejectednumberTotal rejected seats
totalAssignednumberTotal assigned seats (approved permissions and invitations)
totalPendingnumberTotal pending requests (pending permissions and invitations)
Responses
RouteAvailability updated

