Get all route availability students with pagination
Retrieve a paginated list of route availability students based on query parameters
query Parameters
datestring · date-time · requiredRoute availability student date
pagenumberCurrent page
pageSizenumberPage size
Responses
dataarray[] · requiredData
pagenumberCurrent page
pageSizenumberPage size
totalnumberTotal
lastPagenumberLast page
nextstringNext page (endpoint)
previousstringPrevious page (endpoint)
Create a route availability student
Create a new route availability student association
Request Body
datestring · date-time · requiredDate for the route availability
statusstring · enum · requiredStatus of the student in the route
Enum values:APPROVEDREJECTEDNO_BOARDPENDINGstudentFirstNamestring · requiredStudent first name
studentLastNamestring · requiredStudent last name
levelstring · requiredSchool level of the student
Example: PrimaryisFixedPermissionboolean · requiredIs this a fixed permission
Default: false
studentSecondLastNamestringStudent second last name
permissionTypestring · enumPermission type
Enum values:absenceroute-changeno-after-schoolauto-pickuphostFirstNamestringHost first name
hostLastNamestringHost last name
hostSecondLastNamestringHost second last name
destinationRouteobjectDestination route (where the student is going if they are not boarding their original route)
reasonstringReason for the status change
Responses
RouteAvailabilityStudent created
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
datestring · date-time · requiredDate for the route availability
statusstring · enum · requiredStatus of the student in the route
Enum values:APPROVEDREJECTEDNO_BOARDPENDINGstudentFirstNamestring · requiredStudent first name
studentLastNamestring · requiredStudent last name
levelstring · requiredSchool level of the student
Example: PrimaryisFixedPermissionboolean · requiredIs this a fixed permission
Default: false
studentSecondLastNamestringStudent second last name
permissionTypestring · enumPermission type
Enum values:absenceroute-changeno-after-schoolauto-pickuphostFirstNamestringHost first name
hostLastNamestringHost last name
hostSecondLastNamestringHost second last name
destinationRouteobjectDestination route (where the student is going if they are not boarding their original route)
reasonstringReason for the status change
Get route final status
Retrieve the final status of all students for a specific route on a given date
path Parameters
idnumber · min: 1 · requiredId
query Parameters
datestring · date-time · requiredRoute availability student date
pagenumberCurrent page
pageSizenumberPage size
Responses
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
datestring · date-time · requiredDate for the route availability
statusstring · enum · requiredStatus of the student in the route
Enum values:APPROVEDREJECTEDNO_BOARDPENDINGstudentFirstNamestring · requiredStudent first name
studentLastNamestring · requiredStudent last name
levelstring · requiredSchool level of the student
Example: PrimaryisFixedPermissionboolean · requiredIs this a fixed permission
Default: false
studentSecondLastNamestringStudent second last name
permissionTypestring · enumPermission type
Enum values:absenceroute-changeno-after-schoolauto-pickuphostFirstNamestringHost first name
hostLastNamestringHost last name
hostSecondLastNamestringHost second last name
destinationRouteobjectDestination route (where the student is going if they are not boarding their original route)
reasonstringReason for the status change
Download PDF with route final status
Generate and download a PDF file containing the final status of a specific route
path Parameters
idnumber · min: 1 · requiredId
query Parameters
datestring · date-time · requiredRoute availability student date
pagenumberCurrent page
pageSizenumberPage size
Responses
Signed URL to download the PDF file
Get route availability students by route ID
Retrieve all students associated with a specific route on a given date
path Parameters
idnumber · min: 1 · requiredId
query Parameters
datestring · date-time · requiredRoute availability student date
pagenumberCurrent page
pageSizenumberPage size
Responses
dataarray[] · requiredData
pagenumberCurrent page
pageSizenumberPage size
totalnumberTotal
lastPagenumberLast page
nextstringNext page (endpoint)
previousstringPrevious page (endpoint)
Get route availability student by ID
Retrieve a specific route availability student by its ID
path Parameters
idnumber · min: 1 · requiredId
Responses
RouteAvailabilityStudent detail
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
datestring · date-time · requiredDate for the route availability
statusstring · enum · requiredStatus of the student in the route
Enum values:APPROVEDREJECTEDNO_BOARDPENDINGstudentFirstNamestring · requiredStudent first name
studentLastNamestring · requiredStudent last name
levelstring · requiredSchool level of the student
Example: PrimaryisFixedPermissionboolean · requiredIs this a fixed permission
Default: false
studentSecondLastNamestringStudent second last name
permissionTypestring · enumPermission type
Enum values:absenceroute-changeno-after-schoolauto-pickuphostFirstNamestringHost first name
hostLastNamestringHost last name
hostSecondLastNamestringHost second last name
destinationRouteobjectDestination route (where the student is going if they are not boarding their original route)
reasonstringReason for the status change
Update a route availability student
Update an existing route availability student association by its ID
path Parameters
idnumber · min: 1 · requiredId
Request Body
datestring · date-timeDate for the route availability
statusstring · enumStatus of the student in the route
Enum values:APPROVEDREJECTEDNO_BOARDPENDINGstudentFirstNamestringStudent first name
studentLastNamestringStudent last name
studentSecondLastNamestringStudent second last name
levelstringSchool level of the student
Example: PrimarypermissionTypestring · enumPermission type
Enum values:absenceroute-changeno-after-schoolauto-pickuphostFirstNamestringHost first name
hostLastNamestringHost last name
hostSecondLastNamestringHost second last name
destinationRouteobjectDestination route (where the student is going if they are not boarding their original route)
isFixedPermissionbooleanIs this a fixed permission
Default: falsereasonstringReason for the status change
Responses
RouteAvailabilityStudent updated