Brein API

Schemas

User

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
emailstring · required
Username of User
Default: email@user.com
firstNamestring · required
First name of User
Example: John
lastNamestring · required
Last name of User
Example: Doe
secondLastNamestring · required
Second last name of the user
Example: Smith
uidstring · required
Firebase UID
phonestring · required
Phone
picturestring · required
Document slug
Example: /{tenant-id}/user/{slug}
timeZoneOffsetnumber · required
Timezone offset of the user
Example: -180

preferredLanguagestring · enum
The preferred language of the user
Enum values:
SPANISH
ENGLISH
PORTUGUESE
FRENCH
GERMAN
MANDARIN_CHINESE
KOREAN
JAPANESE
Example: SPANISH

UserPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

UserByRoleQueryDto

levelsstring[] · required
School levels
Example: Middle School

pagenumber
Current page
pageSizenumber
Page size
gradesnumber[]
Grade list
administrativeRolesstring[]
Filter by administrative roles
Enum values:
PARENT
DELEGATE
DIRECTOR
TEACHER
ADMINISTRATIVE_COMMUNICATION
ADMINISTRATIVE_LOST_AND_FOUND
ADMINISTRATIVE_PERMISSIONS_MANAGER
SCHOOL_ADMINISTRATOR
Example: ["ADMINISTRATIVE_COMMUNICATION","ADMINISTRATIVE_PERMISSIONS_MANAGER"]
keystring
Filter by multiples key

UserDto

emailstring · required
Username of User
Default: email@user.com
firstNamestring · required
First name of User
Example: John
lastNamestring · required
Last name of User
Example: Doe
secondLastNamestring · required
Second last name of the user
Example: Smith
uidstring · required
Firebase UID
phonestring · required
Phone
picturestring · required
Document slug
Example: /{tenant-id}/user/{slug}
timeZoneOffsetnumber · required
Timezone offset of the user
Example: -180

preferredLanguagestring · enum
The preferred language of the user
Enum values:
SPANISH
ENGLISH
PORTUGUESE
FRENCH
GERMAN
MANDARIN_CHINESE
KOREAN
JAPANESE
Example: SPANISH

BulkDeleteDto

idsnumber[] · required
Group list of Ids

UpdateUserDto

emailstring · required
Username of User
Default: email@user.com
phonestring · required
Phone
firstNamestring · required
First name of User
Example: John
lastNamestring · required
Last name of User
Example: Doe
birthDatestring · date-time · required
Birth date of the administrative
Example: 1980-02-01T12:30:00.000Z
secondLastNamestring · required
Second last name of the user
Example: Smith
addressstring · required
Street of the address
Example: Main St
gradesstring[] · required
Grade level the teacher is responsible for
Example: ["1","2"]
levelsstring[] · required
School level the teacher is associated with
Example: ["Primary","Middle School"]
picturestring · required
Profile picture slug
Example: /{tenant-id}/user/{slug}

preferredLanguagestring · enum
The preferred language of the user
Enum values:
SPANISH
ENGLISH
PORTUGUESE
FRENCH
GERMAN
MANDARIN_CHINESE
KOREAN
JAPANESE
Example: SPANISH

BulkInviteDto

idsnumber[] · required
User list of Ids to send invites to

Administrative

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
levelsstring[] · required
School levels
Example: ["Primary"]
lastNamestring · required
Last name of the administrative
Example: Doe
firstNamestring · required
First name of the administrative
Example: Jane
secondLastNamestring · required
Second last name of the administrative
Example: Smith
birthDatestring · date-time · required
Birth date of the administrative
Example: 1980-02-01T12:30:00.000Z

AdministrativePaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

CreateAdministrativeDto

levelsstring[] · required
School levels
Example: ["Primary"]
lastNamestring · required
Last name of the administrative
Example: Doe
firstNamestring · required
First name of the administrative
Example: Jane
secondLastNamestring · required
Second last name of the administrative
Example: Smith
birthDatestring · date-time · required
Birth date of the administrative
Example: 1980-02-01T12:30:00.000Z
phonestring · required
Phone
Example: +523517892545
administrativeRolesstring[] · required
Administrative role assigned
Enum values:
ADMINISTRATIVE_COMMUNICATION
ADMINISTRATIVE_LOST_AND_FOUND
ADMINISTRATIVE_PERMISSIONS_MANAGER
DIRECTOR
ADMINISTRATIVE_TRANSPORT
SCHOOL_ADMINISTRATOR

emailstring
Email of administrative
Default: email@administrative.com

UpdateAdministrativeDto

levelsstring[]
School levels
Example: ["Primary"]
lastNamestring
Last name of the administrative
Example: Doe
firstNamestring
First name of the administrative
Example: Jane
secondLastNamestring
Second last name of the administrative
Example: Smith
birthDatestring · date-time
Birth date of the administrative
Example: 1980-02-01T12:30:00.000Z

BulkProcess

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
slugstring · required
Slug process
keystring · required
Key process
entitystring · required
Entity name
statusstring · required
Status process
tenantIdstring · required
Tenant Id

BulkProcessPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

BulkProcessDto

slugstring · required
Slug process
keystring · required
Key process
entitystring · required
Entity name
statusstring · required
Status process
tenantIdstring · required
Tenant Id

UpdateBulkProcessDto

slugstring
Slug process
keystring
Key process
entitystring
Entity name
statusstring
Status process
tenantIdstring
Tenant Id

Role

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of the role
Example: parent

RolePaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

RoleDto

namestring · required
Name of the role
Example: parent

UpdateRoleDto

namestring
Name of the role
Example: parent

RoleUser

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

RoleUserPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

CreateRoleUserDto

userIdnumber · required
roleIdnumber · required

UpdateRoleUserDto

Parent

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
lastNamestring · required
Last name of the parent
Example: Doe
secondLastNamestring · required
Second last name of the parent
Example: Smith
relationShipstring · required
Relation ship of the parent with student
Example: Mother
namestring · required
First name of the parent
Example: Jane
genrestring · required
Gender of the parent
Example: FEMALE
phonestring · required
Phone
birthDatestring · date-time · required
Birth date of the parent
Example: 1980-02-01T12:30:00.000Z

ParentPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

CreateParentDto

lastNamestring · required
Last name of the parent
Example: Doe
secondLastNamestring · required
Second last name of the parent
Example: Smith
relationShipstring · required
Relation ship of the parent with student
Example: Mother
namestring · required
First name of the parent
Example: Jane
genrestring · required
Gender of the parent
Example: FEMALE
phonestring · required
Phone
birthDatestring · date-time · required
Birth date of the parent
Example: 1980-02-01T12:30:00.000Z
emailstring · required
Parent email
Default: email@user.com

familyIdnumber
Family ID

UpdateParentDto

lastNamestring
Last name of the parent
Example: Doe
secondLastNamestring
Second last name of the parent
Example: Smith
relationShipstring
Relation ship of the parent with student
Example: Mother
namestring
First name of the parent
Example: Jane
genrestring
Gender of the parent
Example: FEMALE
phonestring
Phone
birthDatestring · date-time
Birth date of the parent
Example: 1980-02-01T12:30:00.000Z

Parameters

typestring · required
Type
textstring · required
Text

Notification

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
phonestring · required
Phone
statusstring · enum · required
Notification status
Enum values:
SENT
FAILED
templatestring · required
Template (whatsapp | email)
parametersobject[] · required
Dynamic parameters
Example: [{"type":"text","text":"value"}]
dataobject | null · required
Dynamic parameters
originstring · enum · required
Notification origin
Enum values:
PUSH
WHATSAPP
EMAIL
Default: PUSH
titlestring · required
Title
payloadstring · required
Payload
notificationTypestring · enum · required
Notification type
Enum values:
NEW_EVENT
NEW_PENDING
NEW_POST
NEW_POST_CLASSROOM
LOST_ARTICLE
LOST_ARTICLE_CLAIMED
LOST_ARTICLE_DELIVERED
NEWSLETTER
Default: NEW_EVENT
readboolean · required
Read

stackstring
Stack error

NotificationPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

NotificationDto

statusstring · enum · required
Notification status
Enum values:
SENT
FAILED
templatestring · required
Template (whatsapp | email)
parametersobject[] · required
Dynamic parameters
Example: [{"type":"text","text":"value"}]
dataobject | null · required
Dynamic parameters
originstring · enum · required
Notification origin
Enum values:
PUSH
WHATSAPP
EMAIL
Default: PUSH
titlestring · required
Title
payloadstring · required
Payload
notificationTypestring · enum · required
Notification type
Enum values:
NEW_EVENT
NEW_PENDING
NEW_POST
NEW_POST_CLASSROOM
LOST_ARTICLE
LOST_ARTICLE_CLAIMED
LOST_ARTICLE_DELIVERED
NEWSLETTER
Default: NEW_EVENT
readboolean · required
Read
userIdnumber · min: 1 · required
user id
Example: 1

stackstring
Stack error

UpdateNotificationDto

statusstring · enum
Notification status
Enum values:
SENT
FAILED
templatestring
Template (whatsapp | email)
parametersobject[]
Dynamic parameters
Example: [{"type":"text","text":"value"}]
dataobject | null
Dynamic parameters
stackstring
Stack error
originstring · enum
Notification origin
Enum values:
PUSH
WHATSAPP
EMAIL
Default: PUSH
titlestring
Title
payloadstring
Payload
notificationTypestring · enum
Notification type
Enum values:
NEW_EVENT
NEW_PENDING
NEW_POST
NEW_POST_CLASSROOM
LOST_ARTICLE
LOST_ARTICLE_CLAIMED
LOST_ARTICLE_DELIVERED
NEWSLETTER
Default: NEW_EVENT
readboolean
Read
userIdnumber · min: 1
user id
Example: 1

NotificationPreferences

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
enableNotificationsboolean · required
Global enable notifications switch
pushNotificationsboolean · required
Enable push notifications
emailNotificationsboolean · required
Enable email notifications
emailWeeklySummaryboolean · required
Weekly summary via email
emailNewActivityboolean · required
Activity via email (new event, task or invite)
notifyNewTaskboolean · required
Receive new task notifications
notifyTaskExpiringboolean · required
Receive task about to expire notifications
notifyTaskReminderboolean · required
Receive task reminder notifications
notifyTaskCompletedboolean · required
Receive task completed notifications
notifyNewEventboolean · required
Receive new event notifications
notifyBeforeEventboolean · required
Receive reminder before event notifications
notifySchoolPostboolean · required
Receive notifications for school posts
notifyClassroomPostboolean · required
Receive notifications for classroom posts
eventReminderTimingstring · enum · required
Event reminder timing
Enum values:
SAME_DAY
ONE_DAY_BEFORE
ONE_WEEK_BEFORE
Default: ONE_DAY_BEFORE

CreateNotificationPreferencesDto

enableNotificationsboolean · required
Global enable notifications switch
pushNotificationsboolean · required
Enable push notifications
emailNotificationsboolean · required
Enable email notifications
emailWeeklySummaryboolean · required
Weekly summary via email
emailNewActivityboolean · required
Activity via email (new event, task or invite)
notifyNewTaskboolean · required
Receive new task notifications
notifyTaskExpiringboolean · required
Receive task about to expire notifications
notifyTaskReminderboolean · required
Receive task reminder notifications
notifyTaskCompletedboolean · required
Receive task completed notifications
notifyNewEventboolean · required
Receive new event notifications
notifyBeforeEventboolean · required
Receive reminder before event notifications
notifySchoolPostboolean · required
Receive notifications for school posts
notifyClassroomPostboolean · required
Receive notifications for classroom posts
eventReminderTimingstring · enum · required
Event reminder timing
Enum values:
SAME_DAY
ONE_DAY_BEFORE
ONE_WEEK_BEFORE
Default: ONE_DAY_BEFORE

UpdateNotificationPreferencesDto

enableNotificationsboolean
Global enable notifications switch
pushNotificationsboolean
Enable push notifications
emailNotificationsboolean
Enable email notifications
emailWeeklySummaryboolean
Weekly summary via email
emailNewActivityboolean
Activity via email (new event, task or invite)
notifyNewTaskboolean
Receive new task notifications
notifyTaskExpiringboolean
Receive task about to expire notifications
notifyTaskReminderboolean
Receive task reminder notifications
notifyTaskCompletedboolean
Receive task completed notifications
notifyNewEventboolean
Receive new event notifications
notifyBeforeEventboolean
Receive reminder before event notifications
notifySchoolPostboolean
Receive notifications for school posts
notifyClassroomPostboolean
Receive notifications for classroom posts
eventReminderTimingstring · enum
Event reminder timing
Enum values:
SAME_DAY
ONE_DAY_BEFORE
ONE_WEEK_BEFORE
Default: ONE_DAY_BEFORE

Teacher

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
gradesstring[] · required
Grade level the teacher is responsible for
Example: ["5th Grade"]
levelstring · required
School level the teacher is associated with
Example: Primary
lastNamestring · required
Last name of the teacher
Example: Doe
firstNamestring · required
First name of the teacher
Example: Jane
secondLastNamestring · required
Second last name of the teacher
Example: Smith
birthDatestring · date-time · required
Birth date of the teacher
Example: 1980-02-01T12:30:00.000Z

TeacherPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

CreateTeacherDto

gradesstring[] · required
Grade level the teacher is responsible for
Example: ["5th Grade"]
levelstring · required
School level the teacher is associated with
Example: Primary
lastNamestring · required
Last name of the teacher
Example: Doe
firstNamestring · required
First name of the teacher
Example: Jane
secondLastNamestring · required
Second last name of the teacher
Example: Smith
birthDatestring · date-time · required
Birth date of the teacher
Example: 1980-02-01T12:30:00.000Z
phonestring · required
Phone
Example: +523517894545

emailstring
Email of teacher
Default: email@teacher.com

UpdateTeacherDto

gradesstring[]
Grade level the teacher is responsible for
Example: ["5th Grade"]
levelstring
School level the teacher is associated with
Example: Primary
lastNamestring
Last name of the teacher
Example: Doe
firstNamestring
First name of the teacher
Example: Jane
secondLastNamestring
Second last name of the teacher
Example: Smith
birthDatestring · date-time
Birth date of the teacher
Example: 1980-02-01T12:30:00.000Z

School

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
tenantIdstring · required
Tenant ID for the school
Example: tenant-123
namestring · required
Name of the school
Example: Springfield High School
emailstring · required
Email school
Example: contact@school.com
phonestring · required
Phone school
Example: +521148863257
slugImgstring · required
Slug of the school image
Example: /slug-school/school-123.png
levelsstring[] · required
Levels of the school
Example: Middle School, High School
statusstring · enum · required
School status
Enum values:
INITIAL_DATA
CONFIGURED

workCenterKeystring
Work center key of the school
Example: 0000001

SchoolPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

SchoolStatsDto

studentsCountnumber · required
Students count
Example: 150
mothersCountnumber · required
Mothers count
Example: 120
fathersCountnumber · required
Fathers count
Example: 100
delegatesCountnumber · required
Delegates count
Example: 25
teachersCountnumber · required
Teachers count
Example: 30
administrativeCountnumber · required
Administrative count
Example: 15
usersCountnumber · required
Users count
Example: 440

SchoolSignedUrlDto

methodstring · required
Method of request (GET | PUT)
Example: GET
contentTypestring · required
Content type of de image
Example: image/webp

AdministratorForSchoolDto

lastNamestring · required
Last name of the administrator
Example: Doe
secondLastNamestring · required
Second last name of the administrator
Example: Smith
firstNamestring · required
First name of the administrator
Example: Jane
phonestring · required
Phone number of Administrator
Example: +541175975884
emailstring · required
Email of Administrator
Default: email@user.com

CreateSchoolDto

namestring · required
Name of the school
Example: Springfield High School
administratorobject · required
School Administrator

workCenterKeystring
Work center key of the school
Example: 0000001

UpdateAddressSchoolDto

addressIdnumber · min: 1 · required
Address id
Example: 1

schoolIdnumber · min: 1
School id (required for SUPER_ADMIN)
Example: 1

AddressDto

formattedAddressstring · required
Street of the address
Example: Main St
zipCodestring · required
Postal code of the address
Example: 10001
citystring · required
City of the address
Example: New York
countrystring · required
Country of the address
Example: USA
placeIdstring · required
Place id maps
latitudenumber · required
Geo latitude
longitudenumber · required
Geo longitude

UpdateSchoolDto

tenantIdstring
Tenant ID for the school
Example: tenant-123
workCenterKeystring
Work center key of the school
Example: 0000001
namestring
Name of the school
Example: Springfield High School
emailstring
Email school
Example: contact@school.com
phonestring
Phone school
Example: +521148863257
slugImgstring
Slug of the school image
Example: /slug-school/school-123.png
levelsstring[]
Levels of the school
Example: Middle School, High School
statusstring · enum
School status
Enum values:
INITIAL_DATA
CONFIGURED
addressobject
School address

SchoolAdministrator

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
lastNamestring · required
Last name of the administrator
Example: Doe
secondLastNamestring · required
Second last name of the administrator
Example: Smith
firstNamestring · required
First name of the administrator
Example: Jane

SchoolAdministratorPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

CreateSchoolAdministratorDto

lastNamestring · required
Last name of the administrator
Example: Doe
secondLastNamestring · required
Second last name of the administrator
Example: Smith
firstNamestring · required
First name of the administrator
Example: Jane
schoolIdnumber · min: 1 · required
School id
Example: 1

UpdateSchoolAdministratorDto

lastNamestring
Last name of the administrator
Example: Doe
secondLastNamestring
Second last name of the administrator
Example: Smith
firstNamestring
First name of the administrator
Example: Jane

Address

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
formattedAddressstring · required
Street of the address
Example: Main St
zipCodestring · required
Postal code of the address
Example: 10001
citystring · required
City of the address
Example: New York
countrystring · required
Country of the address
Example: USA
placeIdstring · required
Place id maps
latitudenumber · required
Geo latitude
longitudenumber · required
Geo longitude

AddressPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

UpdateAddressDto

formattedAddressstring
Street of the address
Example: Main St
zipCodestring
Postal code of the address
Example: 10001
citystring
City of the address
Example: New York
countrystring
Country of the address
Example: USA
placeIdstring
Place id maps
latitudenumber
Geo latitude
longitudenumber
Geo longitude

ApplicationModule

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

ApplicationModulePaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

ApplicationModuleDto

moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false
schoolIdnumber · required
School ID
Example: 1

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

UpdateApplicationModuleDto

moduleTypestring · enum
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring
Module name
Example: Task Management
descriptionstring
Module description
Example: Module for managing tasks and assignments
isEnabledboolean
Whether the module is enabled for this school
Example: true
isRequiredboolean
Whether the module is required (cannot be disabled)
Example: false
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]
schoolIdnumber
School ID
Example: 1

ToggleModuleDto

isEnabledboolean · required
Whether to enable or disable the module
Example: true

BulkToggleModulesDto

modulesarray[] · required
Array of module updates

Family

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
familyNumberstring · required
Family number
Example: 2000

routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

FamilyPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

ParentOfFamily

lastNamestring · required
Last name of the parent
Example: Doe
secondLastNamestring · required
Second last name of the parent
Example: Doe
relationShipstring · required
Relation ship of the parent with student
Example: Mother
namestring · required
First name of the parent
Example: Jane
genrestring · required
Gender of the parent
Example: FEMALE
phonestring · required
Phone
birthDatestring · date-time · required
Birth date of the parent
Example: 1980-02-01T12:30:00.000Z
addressstring · required
Formatted address
Example: Jane
emailstring · required
Parent email
Default: email@user.com

StudentOfFamily

bloodTypestring · required
Blood type of the student
Example: O+
birthDatestring · date-time · required
Birth date of the student
Example: 2025-01-23T10:00:00.000Z
gradestring · required
Grade level of the student
Example: 1
levelstring · required
School level of the student
Example: Primary
enrollmentstring · required
Enrollment number of the student
Example: 12345
firstNamestring · required
First name of the student
Example: John
lastNamestring · required
Last name of the student
Example: Doe
secondLastNamestring · required
Second last name of the user
Example: Smith
genrestring · required
Gender of the student
Example: FEMALE

CreateFamilyDto

familyNumberstring · required
Family number
Example: 2000
parentsobject[] · required
Parents
studentsobject[] · required
Students

routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

UpdateFamilyDto

familyNumberstring
Family number
Example: 2000
routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

ValidateFamilyNumbersDto

familyNumbersstring[] · required
Array of family numbers to validate
Example: ["1","2","3","4","5"]

ValidateFamilyIdsResponseDto

nonExistingFamilyNumbersstring[] · required
Array of non-existing family numbers
Example: ["2","4"]

existingFamilyNumbersobject
Mapping of existing family numbers to their IDs
Example: {"1":123,"3":125,"5":127}

DeviceToken

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
tokenstring · required
Firebase Token Device
platformstring · required
Platform of the device

DeviceTokenPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

DeviceTokenDto

tokenstring · required
Firebase Token Device
platformstring · required
Platform of the device

UpdateDeviceTokenDto

tokenstring
Firebase Token Device
platformstring
Platform of the device

Delegate

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

DelegatePaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

CreateDelegateDto

groupIdnumber
Group ID
parentIdnumber
Parent ID

UpdateDelegateDto

Group

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
startCyclestring · date-time · required
Start cycle associated with the group
endCyclestring · date-time · required
End cycle associated with the group
levelstring · required
Level of the group
Example: High School
gradesstring[] · required
Grade of the group
Example: 12th Grade
namestring · required
Name of the group
Example: Group A
descriptionstring · required
Description of the group
Example: Group A Description
slugImgstring · required
Slug of the group image
Example: /slug-school/1-group.png

GroupPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GroupParticipantsQueryDto

schoolIdnumber · min: 1 · required
School id
Example: 1

pagenumber
Current page
pageSizenumber
Page size
keystring
Filter by multiples key
rolesstring[]
Role list
gradesnumber[]
Grade list
levelsstring[]
Level list

AddParticipantsDto

studentIdsnumber[] · required
Student list of Ids
teacherIdsnumber[] · required
Teacher list of Ids

RemoveParticipantsDto

studentIdsnumber[] · required
Student list of Ids
teacherIdsnumber[] · required
Teacher list of Ids

GroupDto

startCyclestring · date-time · required
Start cycle associated with the group
endCyclestring · date-time · required
End cycle associated with the group
levelstring · required
Level of the group
Example: High School
gradesstring[] · required
Grade of the group
Example: 12th Grade
namestring · required
Name of the group
Example: Group A
descriptionstring · required
Description of the group
Example: Group A Description
slugImgstring · required
Slug of the group image
Example: /slug-school/1-group.png

UpdateGroupDto

startCyclestring · date-time
Start cycle associated with the group
endCyclestring · date-time
End cycle associated with the group
levelstring
Level of the group
Example: High School
gradesstring[]
Grade of the group
Example: 12th Grade
namestring
Name of the group
Example: Group A
descriptionstring
Description of the group
Example: Group A Description
slugImgstring
Slug of the group image
Example: /slug-school/1-group.png

GroupSignedUrlDto

methodstring · required
Method of request (GET | PUT)
Example: GET
contentTypestring · required
Content type of de image
Example: image/webp

GroupNotificationDto

groupIdsnumber[] · required
Array of group IDs to send notifications to
Example: [1,2,3]

GroupNotificationResponseDto

messagestring · required
Success message
Example: Notifications sent successfully
notificationsSentnumber · required
Number of notifications sent
Example: 10

GroupTeacher

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

GroupTeacherPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GroupTeacherDto

UpdateGroupTeacherDto

GroupStudent

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

GroupStudentPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GroupStudentDto

UpdateGroupStudentDto

Student

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
bloodTypestring · required
Blood type of the student
Example: O+
birthDatestring · date-time · required
Birth date of the student
Example: 2025-01-23T10:00:00.000Z
gradestring · required
Grade level of the student
Example: 1
levelstring · required
School level of the student
Example: Primary
enrollmentstring · required
Enrollment number of the student
Example: 12345
firstNamestring · required
First name of the student
Example: John
lastNamestring · required
Last name of the student
Example: Doe
secondLastNamestring · required
Second last name of the user
Example: Smith
genrestring · required
Gender of the student
Example: FEMALE

StudentPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

CreateStudentDto

bloodTypestring · required
Blood type of the student
Example: O+
birthDatestring · date-time · required
Birth date of the student
Example: 2025-01-23T10:00:00.000Z
gradestring · required
Grade level of the student
Example: 1
levelstring · required
School level of the student
Example: Primary
enrollmentstring · required
Enrollment number of the student
Example: 12345
firstNamestring · required
First name of the student
Example: John
lastNamestring · required
Last name of the student
Example: Doe
secondLastNamestring · required
Second last name of the user
Example: Smith
genrestring · required
Gender of the student
Example: FEMALE

familyIdnumber
Family Id

IdParams

idnumber · min: 1 · required
Id
Example: 1

UpdateStudentDto

bloodTypestring
Blood type of the student
Example: O+
birthDatestring · date-time
Birth date of the student
Example: 2025-01-23T10:00:00.000Z
gradestring
Grade level of the student
Example: 1
levelstring
School level of the student
Example: Primary
enrollmentstring
Enrollment number of the student
Example: 12345
firstNamestring
First name of the student
Example: John
lastNamestring
Last name of the student
Example: Doe
secondLastNamestring
Second last name of the user
Example: Smith
genrestring
Gender of the student
Example: FEMALE

RouteStudent

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

RouteStudentPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

RouteStudentDto

routeIdnumber · required
studentIdnumber · required

UpdateRouteStudentDto

routeIdnumber
studentIdnumber

SuspendRouteStudentDto

BulkDeleteRouteStudentsDto

idsnumber[] · required
Array of RouteStudent IDs to delete
Example: [1,2,3,4,5]

Transport

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
routeNumbernumber · required
Route number
unitCapacitynumber · required
Maximum capacity of the unit

unitNumbernumber
Unit number
licencePlatestring
Licence plate of the unit

Route

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
transportobject · required
Transport

mapUrlstring
Map URL
operatorFirstNamestring
First name of the operator
operatorLastNamestring
Last name of the operator
monitorFirstNamestring
First name of the monitor
monitorLastNamestring
Last name of the monitor
phonestring
Phone number

RoutePaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

MonitorInfoDto

firstNamestring
Monitor first name
lastNamestring
Monitor last name
phonestring
Route phone number

TransportAdminInfoDto

firstNamestring
Transport admin first name
lastNamestring
Transport admin last name
emailstring
Transport admin email
phonestring
Transport admin phone number

RouteMeResponseDto

monitorobject
Monitor information
transportAdminobject
Transport admin information
routeDocumentSlugstring
Route document slug

TransportDto

routeNumbernumber · required
Route number
unitCapacitynumber · required
Maximum capacity of the unit

unitNumbernumber
Unit number
licencePlatestring
Licence plate of the unit

RouteDto

transportobject · required
Transport data

mapUrlstring
Map URL
operatorFirstNamestring
First name of the operator
operatorLastNamestring
Last name of the operator
monitorFirstNamestring
First name of the monitor
monitorLastNamestring
Last name of the monitor
phonestring
Phone number
scheduleIdnumber
Schedule ID

UpdateRouteDto

mapUrlstring
Map URL
operatorFirstNamestring
First name of the operator
operatorLastNamestring
Last name of the operator
monitorFirstNamestring
First name of the monitor
monitorLastNamestring
Last name of the monitor
phonestring
Phone number
scheduleIdnumber
Schedule ID
transportobject
Transport data

ScheduleConfiguration

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
permissionTimeLimitnumber · required
Number of hours in advance required to request permission
permissionWeeksInAdvancenumber · enum · required
Weeks in advance for receiving permissions
Enum values:
1
2
3
4
Example: 1

SchoolSchedule

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

SchoolSchedulePaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

SchoolScheduleDto

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

UpdateSchoolScheduleDto

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

SchoolConfiguration

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
limitExitPermissionnumber · required
Hours in advance required for exit permission requests
Example: 24
startCyclestring · date-time · required
Start date of the school cycle
Example: 2025-01-14T01:14:37.659Z
endCyclestring · date-time · required
End date of the school cycle
Example: 2025-01-14T01:14:37.659Z
entryTimestring · required
Entry time to the school
Example: 08:00:00
regularExitTimestring · required
Regular exit time from school
Example: 14:00:00
customExitTimestring · required
Custom exit time from school for specific cases
Example: 16:00:00
showFamilyPhoneNumberboolean · required
Show family phone number in the exit permission form
Example: true
showFamilyEmailboolean · required
Show family email in the exit permission form
Example: true

SchoolConfigurationPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

AttachSchoolHolidayCycleDto

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
idnumber · required
Id

CreateSchoolConfigurationDto

limitExitPermissionnumber · required
Hours in advance required for exit permission requests
Example: 24
startCyclestring · date-time · required
Start date of the school cycle
Example: 2025-01-14T01:14:37.659Z
endCyclestring · date-time · required
End date of the school cycle
Example: 2025-01-14T01:14:37.659Z
entryTimestring · required
Entry time to the school
Example: 08:00:00
regularExitTimestring · required
Regular exit time from school
Example: 14:00:00
customExitTimestring · required
Custom exit time from school for specific cases
Example: 16:00:00
showFamilyPhoneNumberboolean · required
Show family phone number in the exit permission form
Example: true
showFamilyEmailboolean · required
Show family email in the exit permission form
Example: true
holidayCyclesobject[] · required
Holidays

UpdateSchoolConfigurationDto

limitExitPermissionnumber
Hours in advance required for exit permission requests
Example: 24
startCyclestring · date-time
Start date of the school cycle
Example: 2025-01-14T01:14:37.659Z
endCyclestring · date-time
End date of the school cycle
Example: 2025-01-14T01:14:37.659Z
entryTimestring
Entry time to the school
Example: 08:00:00
regularExitTimestring
Regular exit time from school
Example: 14:00:00
customExitTimestring
Custom exit time from school for specific cases
Example: 16:00:00
showFamilyPhoneNumberboolean
Show family phone number in the exit permission form
Example: true
showFamilyEmailboolean
Show family email in the exit permission form
Example: true
holidayCyclesobject[]
Holidays

SchoolHolidayCycle

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

SchoolHolidayCyclePaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

CreateSchoolHolidayCycleDto

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

UpdateSchoolHolidayCycleDto

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

TransportPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

UpdateTransportDto

routeNumbernumber
Route number
unitNumbernumber
Unit number
unitCapacitynumber
Maximum capacity of the unit
licencePlatestring
Licence plate of the unit

Permission

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of the permission
Example: Manage Users

PermissionPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

PermissionDto

namestring · required
Name of the permission
Example: Manage Users

UpdatePermissionDto

namestring
Name of the permission
Example: Manage Users

Documents

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Document name
Example: Terms and conditions
slugstring · required
Document slug
Example: /{tenant-id}/documents/{name}

DocumentsPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

DocumentsDto

namestring · required
Document name
Example: Terms and conditions
slugstring · required
Document slug
Example: /{tenant-id}/documents/{name}

UploadDocumentsDto

contentTypestring · required
Content type of the document
Example: application/pdf
slugstring · required
Document slug
Example: tenant-id/doc/file.pdf
namestring · required
Document name
Example: file.pdf

methodstring
Method ( GET | PUT )
Example: PUT

UpdateDocumentsDto

namestring
Document name
Example: Terms and conditions
slugstring
Document slug
Example: /{tenant-id}/documents/{name}

ExportReportDto

urlstring · required
Signed URL for the exported report
Example: https://example.com/report.pdf

LegalDocuments

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
termsAndConditionsstring · required
Terms and Conditions
privacyPolicystring · required
Privacy Policy
termsAndConditionsVersionstring · required
Terms and Conditions Version
privacyPolicyVersionstring · required
Privacy Policy Version

LegalDocumentsPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

LegalDocumentsDto

termsAndConditionsstring · required
Terms and Conditions
privacyPolicystring · required
Privacy Policy
termsAndConditionsVersionstring · required
Terms and Conditions Version
privacyPolicyVersionstring · required
Privacy Policy Version

UpdateLegalDocumentsDto

termsAndConditionsstring
Terms and Conditions
privacyPolicystring
Privacy Policy
termsAndConditionsVersionstring
Terms and Conditions Version
privacyPolicyVersionstring
Privacy Policy Version

SendCodeDto

phonestring · required
Phone

Auth

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
codestring · required
2FA Code
expirationDatestring · required
Expiration date

VerifyCodeDto

phonestring · required
Phone
codestring · required
Code

VerifyPhoneDto

phonestring · required
Phone

Session

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
sessionDurationnumber · required
Session duration
Example: 15
breakBetweenSessionsnumber · required
Break between sessions
Example: 15
statusstring · enum · required
Status of session
Enum values:
DRAFT
PUBLISHED

taskobject
Associated task

Task

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
titlestring · required
Title task
dueDatestring · date-time · required
Expiration date
mandatoryboolean · required
Task mandatory?
descriptionstring · required
Description task
documentSlugsstring[] · required
Document slugs

sessionobject
Associated session
reasonstring
Reason for deletion

TaskPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

CreateTaskDto

titlestring · required
Title task
dueDatestring · date-time · required
Expiration date
mandatoryboolean · required
Task mandatory?
descriptionstring · required
Description task
documentSlugsstring[] · required
Document slugs
groupIdsnumber[] · required
Group list of Ids

sessionobject
Associated session
reasonstring
Reason for deletion

DeleteTaskDto

reasonstring
Reason

UpdateTaskDto

titlestring
Title task
dueDatestring · date-time
Expiration date
mandatoryboolean
Task mandatory?
descriptionstring
Description task
documentSlugsstring[]
Document slugs
sessionobject
Associated session
reasonstring
Reason for deletion
groupIdsnumber[]
Group list of Ids

TaskSignedUrlDto

methodstring · required
Method of request (GET | PUT)
Example: GET
contentTypestring · required
Content type of de document
Example: image/webp
slugstring · required
Document slug
Example: 1-school

SessionPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

CreateSessionDto

groupIdsnumber[] · required
Group list of Ids
titlestring · required
Session title
mandatoryboolean · required
Session mandatory?

descriptionstring
Session description

DeleteByTaskIdDto

reasonstring
Reason

UpdateSessionDto

sessionDurationnumber · required
Session duration
Example: 15
breakBetweenSessionsnumber · required
Break between sessions
Example: 15
statusstring · enum · required
Status of session
Enum values:
DRAFT
PUBLISHED

UpdateSessionSlotsDto

sessionDurationnumber · required
Session duration in minutes
breakBetweenSessionsnumber · required
Break between sessions in minutes
daysstring[] · required
Days with start and end time
Example: [{"startTime":"2025-04-26T21:00:04.989Z","endTime":"2025-04-28T23:50:04.989Z"}]

PublishSessionDayDto

idnumber · required
Session day id

eventTypestring · enum
Event type
Enum values:
ON_SITE
REMOTE
BOTH
SESSION
meetingLinkstring
Meeting link
locationstring
Location

PublishSessionDto

daysobject[] · required
Session days

CreateTaskReminderDto

TimeSlot

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
availableboolean · required
Session available?

SessionDay

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
datestring · date-time · required
Session date
eventTypestring · enum · required
Event type of session
Enum values:
ON_SITE
REMOTE
BOTH
locationstring · required
Session location
meetingLinkstring · required
Session meeting link
slotsobject[] · required
Time slots for the day
reasonstring · required
Reason for deletion

SessionDayPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

TimeSlotDto

startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
availableboolean · required
Session available?
idnumber · required
Id

CreateSessionDayDto

datestring · date-time · required
Session date
eventTypestring · enum · required
Event type of session
Enum values:
ON_SITE
REMOTE
BOTH
locationstring · required
Session location
meetingLinkstring · required
Session meeting link
reasonstring · required
Reason for deletion
slotsobject[] · required
Time slots
sessionIdnumber · min: 1 · required
Session id
Example: 1

UpdateSessionDayDto

datestring · date-time
Session date
eventTypestring · enum
Event type of session
Enum values:
ON_SITE
REMOTE
BOTH
locationstring
Session location
meetingLinkstring
Session meeting link
slotsobject[]
Time slots for the day
reasonstring
Reason for deletion

TimeSlotPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

UpdateTimeSlotDto

startTimestring · date-time
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
availableboolean
Session available?
idnumber
Id

CreateAppointmentDto

studentIdsnumber[]
Student IDs to book the appointment for
Example: [1,2]

Event

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
descriptionstring · required
Description event
eventTypestring · enum · required
Event type
Enum values:
ON_SITE
REMOTE
BOTH
SESSION
mandatoryboolean · required
Event mandatory?
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
timezonestring · required
Timezone of the event
Example: America/Mexico_City
frequencyTypestring · enum · required
Frequency type
Enum values:
NO_REPEAT
WEEKLY
BIWEEKLY
creatorTypestring · enum · required
Creator type
Enum values:
TEACHER
ADMINISTRATIVE
DELEGATE
SCHOOL_ADMINISTRATOR
levelsstring[] · required
School levels
Example: Primary
documentSlugsstring[] · required
Document slugs

studentsobject[]
Students associated with this event
reasonstring
Reason for deletion

EventPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

CreateEventDto

descriptionstring · required
Description event
eventTypestring · enum · required
Event type
Enum values:
ON_SITE
REMOTE
BOTH
SESSION
mandatoryboolean · required
Event mandatory?
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
timezonestring · required
Timezone of the event
Example: America/Mexico_City
frequencyTypestring · enum · required
Frequency type
Enum values:
NO_REPEAT
WEEKLY
BIWEEKLY
levelsstring[] · required
School levels
Example: Primary
documentSlugsstring[] · required
Document slugs
groupIdsnumber[] · required
Group list of Ids

studentsobject[]
Students associated with this event
reasonstring
Reason for deletion

DeleteEventDto

reasonstring · required
Reason

UpdateEventDto

groupIdsnumber[] · required
Group list of Ids

descriptionstring
Description event
eventTypestring · enum
Event type
Enum values:
ON_SITE
REMOTE
BOTH
SESSION
mandatoryboolean
Event mandatory?
startTimestring · date-time
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
timezonestring
Timezone of the event
Example: America/Mexico_City
frequencyTypestring · enum
Frequency type
Enum values:
NO_REPEAT
WEEKLY
BIWEEKLY
creatorTypestring · enum
Creator type
Enum values:
TEACHER
ADMINISTRATIVE
DELEGATE
SCHOOL_ADMINISTRATOR
studentsobject[]
Students associated with this event
levelsstring[]
School levels
Example: Primary
documentSlugsstring[]
Document slugs
reasonstring
Reason for deletion

FixedPermission

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
studentsobject[] · required
List of students for the fixed permission
schedulestring · date-time · required
Schedule time for the permission
startDatestring · date-time · required
Start date for the recurring permission
endDatestring · date-time · required
End date for the recurring permission
weekdaysstring[] · required
Days of the week when the permission repeats
Enum values:
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
recurrenceUnitstring · enum · required
How often the permission repeats
Enum values:
WEEK
MONTH
recurrenceValuenumber · min: 1 · required
Number of units between repetitions
createdBySchoolAdministratorobject · required
School administrator who created the permission
createdByAdministrativeobject · required
Administrative who created the permission
statusstring · enum · required
Status
Enum values:
PENDING
APPROVED
REJECTED
CONFIRMED

messagestring
Additional message
Example: Must return by 18:00

ExitPermission

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
studentsobject[] · required
List of host student associated with the exit permission
datestring · date-time · required
Permission date
createdByobject · required
User who created the permission
confirmedByTeacherobject · required
Teacher who confirmed the exit
confirmedByAdministrativeobject · required
Administrative who confirmed the exit
confirmedBySchoolAdministratorobject · required
School administrator who confirmed the exit
confirmedAtstring · date-time · required
Confirmed at
statusstring · enum · required
Status
Enum values:
PENDING
APPROVED
REJECTED
CONFIRMED
fixedPermissionobject · required
Fixed permission that generated this exit permission

messagestring
Additional message
Example: Must return by 18:00
qrCodestring
QR Code
Example: data:image/png;base64,....

ExitPermissionPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

CreateExitPermissionDto

datestring · date-time · required
Permission date
statusstring · enum · required
Status
Enum values:
PENDING
APPROVED
REJECTED
CONFIRMED
fixedPermissionobject · required
Fixed permission that generated this exit permission
studentIdsnumber[] · required
Student list of Ids

messagestring
Additional message
Example: Must return by 18:00

RouteChangeDto

datestring · date-time · required
Permission date
destinationTypestring · enum · required
Enum values:
trusted_address
student_route
regular_route
studentIdsnumber[] · required
Student list of Ids

messagestring
Additional message
Example: Must return by 18:00
trustedAddressIdnumber
Trusted address ID

RouteChangePermission

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
studentsobject[] · required
List of host student associated with the exit permission
datestring · date-time · required
Permission date
createdByobject · required
User who created the permission
confirmedByTeacherobject · required
Teacher who confirmed the exit
confirmedByAdministrativeobject · required
Administrative who confirmed the exit
confirmedBySchoolAdministratorobject · required
School administrator who confirmed the exit
confirmedAtstring · date-time · required
Confirmed at
statusstring · enum · required
Status
Enum values:
PENDING
APPROVED
REJECTED
CONFIRMED
fixedPermissionobject · required
Fixed permission that generated this exit permission
destinationTypestring · enum · required
Enum values:
trusted_address
student_route
regular_route

messagestring
Additional message
Example: Must return by 18:00
qrCodestring
QR Code
Example: data:image/png;base64,....

NoAfterSchoolDto

datestring · date-time · required
Permission date
statusstring · enum · required
Status
Enum values:
PENDING
APPROVED
REJECTED
CONFIRMED
fixedPermissionobject · required
Fixed permission that generated this exit permission
studentIdsnumber[] · required
Student list of Ids
destinationTypestring · enum · required
Enum values:
trusted_address
student_route
regular_route
departureTypestring · enum · required
Enum values:
regular_route
route_change
car_departure
pickupModestring · enum · required
Enum values:
SELF
CLASSMATE_PARENT
TRUSTED_PERSON

messagestring
Additional message
Example: Must return by 18:00
trustedPeopleIdnumber
Trusted people ID (required when pickupMode is TRUSTED_PERSON)
Example: 1
trustedAddressIdnumber
Trusted address ID

NoAfterSchoolPermission

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
studentsobject[] · required
List of host student associated with the exit permission
datestring · date-time · required
Permission date
createdByobject · required
User who created the permission
confirmedByTeacherobject · required
Teacher who confirmed the exit
confirmedByAdministrativeobject · required
Administrative who confirmed the exit
confirmedBySchoolAdministratorobject · required
School administrator who confirmed the exit
confirmedAtstring · date-time · required
Confirmed at
statusstring · enum · required
Status
Enum values:
PENDING
APPROVED
REJECTED
CONFIRMED
fixedPermissionobject · required
Fixed permission that generated this exit permission
destinationTypestring · enum · required
Enum values:
trusted_address
student_route
regular_route
departureTypestring · enum · required
Enum values:
regular_route
route_change
car_departure
pickupModestring · enum · required
Enum values:
SELF
CLASSMATE_PARENT
TRUSTED_PERSON

messagestring
Additional message
Example: Must return by 18:00
qrCodestring
QR Code
Example: data:image/png;base64,....

AutoPickupDto

datestring · date-time · required
Permission date
statusstring · enum · required
Status
Enum values:
PENDING
APPROVED
REJECTED
CONFIRMED
fixedPermissionobject · required
Fixed permission that generated this exit permission
studentIdsnumber[] · required
Student list of Ids
pickupModestring · enum · required
Pickup mode
Enum values:
SELF
CLASSMATE_PARENT
TRUSTED_PERSON
Example: SELF

messagestring
Additional message
Example: Must return by 18:00
trustedPeopleIdnumber
Trusted people ID (required when pickupMode is TRUSTED_PERSON)
Example: 1

AutoPickupPermission

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
studentsobject[] · required
List of host student associated with the exit permission
datestring · date-time · required
Permission date
createdByobject · required
User who created the permission
confirmedByTeacherobject · required
Teacher who confirmed the exit
confirmedByAdministrativeobject · required
Administrative who confirmed the exit
confirmedBySchoolAdministratorobject · required
School administrator who confirmed the exit
confirmedAtstring · date-time · required
Confirmed at
statusstring · enum · required
Status
Enum values:
PENDING
APPROVED
REJECTED
CONFIRMED
fixedPermissionobject · required
Fixed permission that generated this exit permission
pickupModestring · enum · required
Pickup mode
Enum values:
SELF
CLASSMATE_PARENT
TRUSTED_PERSON
Example: SELF

messagestring
Additional message
Example: Must return by 18:00
qrCodestring
QR Code
Example: data:image/png;base64,....
departureTypestring · enum
Departure type
Enum values:
regular_route
route_change
car_departure
Example: regular_route

AbsenceDto

fixedPermissionobject · required
Fixed permission that generated this exit permission
studentIdsnumber[] · required
Student list of Ids

messagestring
Additional message
Example: Must return by 18:00
reasonstring · enum
Reason for absence
Enum values:
SICK
OTHER
MEDICAL_APPOINTMENT
TRAVEL
PERSONAL_MATTERS
startTimestring · date-time
Start time for partial day absence (use this AND endTime OR date for full day)
Example: 2025-01-27T08:00:00.000Z
endTimestring · date-time
End time for partial day absence (use this AND startTime OR date for full day)
Example: 2025-01-27T16:00:00.000Z
endDatestring · date-time
End date for absence interval (use with date when fullDay is true to create multi-day absence)
Example: 2025-01-31T00:00:00.000Z
datestring · date-time
Date for full day absence (use this OR startTime/endTime for partial absence)
Example: 2025-01-27T00:00:00.000Z
fullDayboolean
Whether the absence is for a full day
Example: true

AbsencePermission

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
studentsobject[] · required
List of host student associated with the exit permission
datestring · date-time · required
Permission date
createdByobject · required
User who created the permission
confirmedByTeacherobject · required
Teacher who confirmed the exit
confirmedByAdministrativeobject · required
Administrative who confirmed the exit
confirmedBySchoolAdministratorobject · required
School administrator who confirmed the exit
confirmedAtstring · date-time · required
Confirmed at
statusstring · enum · required
Status
Enum values:
PENDING
APPROVED
REJECTED
CONFIRMED
fixedPermissionobject · required
Fixed permission that generated this exit permission
reasonstring · enum · required
Reason for absence
Enum values:
SICK
OTHER
MEDICAL_APPOINTMENT
TRAVEL
PERSONAL_MATTERS

messagestring
Additional message
Example: Must return by 18:00
qrCodestring
QR Code
Example: data:image/png;base64,....
fullDayboolean
Whether the absence is for a full day
Example: true
startTimestring · date-time
Start time for partial day absence (use this AND endTime OR date for full day)
Example: 2025-01-27T08:00:00.000Z
endTimestring · date-time
End time for partial day absence (use this AND startTime OR date for full day)
Example: 2025-01-27T16:00:00.000Z
endDatestring · date-time
End date for absence interval (use with date when fullDay is true to create multi-day absence)
Example: 2025-01-31T00:00:00.000Z

UpdateExitPermissionDto

studentsobject[]
List of host student associated with the exit permission
datestring · date-time
Permission date
messagestring
Additional message
Example: Must return by 18:00
createdByobject
User who created the permission
qrCodestring
QR Code
Example: data:image/png;base64,....
confirmedByTeacherobject
Teacher who confirmed the exit
confirmedByAdministrativeobject
Administrative who confirmed the exit
confirmedBySchoolAdministratorobject
School administrator who confirmed the exit
confirmedAtstring · date-time
Confirmed at
statusstring · enum
Status
Enum values:
PENDING
APPROVED
REJECTED
CONFIRMED
fixedPermissionobject
Fixed permission that generated this exit permission

FixedRouteChangePaginationDto

dataarray[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

FixedRouteChangeDto

schedulestring · date-time · required
Schedule time for the permission
startDatestring · date-time · required
Start date for the recurring permission
endDatestring · date-time · required
End date for the recurring permission
weekdaysstring[] · required
Days of the week when the permission repeats
Enum values:
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
recurrenceUnitstring · enum · required
How often the permission repeats
Enum values:
WEEK
MONTH
recurrenceValuenumber · min: 1 · required
Number of units between repetitions
studentIdsnumber[] · required
Student list of Ids

messagestring
Additional message
Example: Must return by 18:00
destinationTypestring · enum
Enum values:
trusted_address
student_route
regular_route
trustedAddressIdnumber
Trusted address ID

FixedRouteChangePermission

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
studentsobject[] · required
List of students for the fixed permission
schedulestring · date-time · required
Schedule time for the permission
startDatestring · date-time · required
Start date for the recurring permission
endDatestring · date-time · required
End date for the recurring permission
weekdaysstring[] · required
Days of the week when the permission repeats
Enum values:
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
recurrenceUnitstring · enum · required
How often the permission repeats
Enum values:
WEEK
MONTH
recurrenceValuenumber · min: 1 · required
Number of units between repetitions
createdBySchoolAdministratorobject · required
School administrator who created the permission
createdByAdministrativeobject · required
Administrative who created the permission
statusstring · enum · required
Status
Enum values:
PENDING
APPROVED
REJECTED
CONFIRMED

messagestring
Additional message
Example: Must return by 18:00
destinationTypestring · enum
Enum values:
trusted_address
student_route
regular_route

FixedAutoPickupPaginationDto

dataarray[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

FixedAutoPickupDto

schedulestring · date-time · required
Schedule time for the permission
startDatestring · date-time · required
Start date for the recurring permission
endDatestring · date-time · required
End date for the recurring permission
weekdaysstring[] · required
Days of the week when the permission repeats
Enum values:
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
recurrenceUnitstring · enum · required
How often the permission repeats
Enum values:
WEEK
MONTH
recurrenceValuenumber · min: 1 · required
Number of units between repetitions
studentIdsnumber[] · required
Student list of Ids
pickupModestring · enum · required
Pickup mode
Enum values:
SELF
CLASSMATE_PARENT
TRUSTED_PERSON
Example: SELF

messagestring
Additional message
Example: Must return by 18:00
trustedPeopleIdnumber
Trusted people ID (required when pickupMode is TRUSTED_PERSON)
Example: 1

FixedAutoPickupPermission

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
studentsobject[] · required
List of students for the fixed permission
schedulestring · date-time · required
Schedule time for the permission
startDatestring · date-time · required
Start date for the recurring permission
endDatestring · date-time · required
End date for the recurring permission
weekdaysstring[] · required
Days of the week when the permission repeats
Enum values:
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
recurrenceUnitstring · enum · required
How often the permission repeats
Enum values:
WEEK
MONTH
recurrenceValuenumber · min: 1 · required
Number of units between repetitions
createdBySchoolAdministratorobject · required
School administrator who created the permission
createdByAdministrativeobject · required
Administrative who created the permission
statusstring · enum · required
Status
Enum values:
PENDING
APPROVED
REJECTED
CONFIRMED
pickupModestring · enum · required
Pickup mode
Enum values:
SELF
CLASSMATE_PARENT
TRUSTED_PERSON
Example: SELF

messagestring
Additional message
Example: Must return by 18:00

StudentInfoDto

idnumber · required
Student ID
firstNamestring · required
Student first name
lastNamestring · required
Student last name

RouteInfoDto

idnumber · required
Route ID
routeNumberstring · required
Route number

CreatorInfoDto

firstNamestring · required
Creator first name
lastNamestring · required
Creator last name

RouteChangeResponseDto

idnumber · required
Permission ID
levelstring · required
Student level
studentobject · required
Student information
originalRouteobject · required
Original route information
creatorobject · required
Creator information
statusstring · enum · required
Permission status
Enum values:
PENDING
APPROVED
REJECTED
CONFIRMED
datestring · date-time · required
Permission date
typestring · required
Permission type

requestedRouteobject
Requested route information

AcceptExitPermissionDto

statusstring · enum · required
Response status - accept or reject the permission
Enum values:
PENDING
ACCEPTED
REJECTED
Example: ACCEPTED

studentIdnumber
Student ID selected by the parent
Example: 123

ExitPermissionInvitation

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
statusstring · enum · required
Enum values:
PENDING
ACCEPTED
REJECTED

TrustedPeople

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name or names of the trusted person
paternalLastNamestring · required
Paternal last name of the trusted person
maternalLastNamestring · required
Maternal last name of the trusted person
phonestring · required
Phone number of the trusted person
genrestring · enum · required
Gender of the trusted person
Enum values:
MALE
FEMALE
OTHER
relationshipstring · enum · required
Relationship of the trusted person with the student
Enum values:
Grandparent
Aunt/Uncle
Friend
Collaborator
slugImagestring · required
S3 image slug for the official identification
statusstring · enum · required
Status of the trusted person
Enum values:
PENDING
APPROVED
REJECTED
REVOKED
requestedByobject · required
Parent who requested the trusted person
requestedAtstring · date-time · required
Date and time when the trusted person was requested
reviewedAtstring · date-time · required
Date and time when the trusted person was reviewed
revokedAtstring · date-time · required
Date and time when the trusted person was revoked

reviewedByobject
User who reviewed the trusted person
reviewedByRolestring · enum
Role of the user who reviewed the trusted person
Enum values:
PARENT
DELEGATE
DIRECTOR
TEACHER
ADMINISTRATIVE_COMMUNICATION
ADMINISTRATIVE_LOST_AND_FOUND
ADMINISTRATIVE_PERMISSIONS_MANAGER
SCHOOL_ADMINISTRATOR
revokedByobject
User who revoked the trusted person

TrustedPeopleHistoryDto

idnumber · required
History entry ID
statusstring · enum · required
Status of the action
Enum values:
PENDING
APPROVED
REJECTED
REVOKED
createdAtstring · date-time · required
Action timestamp

actionByobject
User who performed the action
actionByRolestring · enum
Role of the user who performed the action
Enum values:
PARENT
DELEGATE
DIRECTOR
TEACHER
ADMINISTRATIVE_COMMUNICATION
ADMINISTRATIVE_LOST_AND_FOUND
ADMINISTRATIVE_PERMISSIONS_MANAGER
SCHOOL_ADMINISTRATOR
notesstring
Additional notes

TrustedPeopleDetailDto

idnumber · required
Trusted person basic information
studentsobject[] · required
Student information
requestedByobject · required
Creator information (parent)
historyobject[] · required
Action history

reviewedByobject
User who reviewed the trusted person
reviewedByRolestring · enum
Role of the user who reviewed
Enum values:
PARENT
DELEGATE
DIRECTOR
TEACHER
ADMINISTRATIVE_COMMUNICATION
ADMINISTRATIVE_LOST_AND_FOUND
ADMINISTRATIVE_PERMISSIONS_MANAGER
SCHOOL_ADMINISTRATOR

TrustedPeopleDto

namestring · required
Name or names of the trusted person
paternalLastNamestring · required
Paternal last name of the trusted person
maternalLastNamestring · required
Maternal last name of the trusted person
phonestring · required
Phone number of the trusted person
genrestring · enum · required
Gender of the trusted person
Enum values:
MALE
FEMALE
OTHER
relationshipstring · enum · required
Relationship of the trusted person with the student
Enum values:
Grandparent
Aunt/Uncle
Friend
Collaborator
slugImagestring · required
S3 image slug for the official identification
familyIdnumber · required
Family ID

UpdateTrustedPeopleDto

namestring
Name or names of the trusted person
paternalLastNamestring
Paternal last name of the trusted person
maternalLastNamestring
Maternal last name of the trusted person
phonestring
Phone number of the trusted person
genrestring · enum
Gender of the trusted person
Enum values:
MALE
FEMALE
OTHER
relationshipstring · enum
Relationship of the trusted person with the student
Enum values:
Grandparent
Aunt/Uncle
Friend
Collaborator
slugImagestring
S3 image slug for the official identification
familyIdnumber
Family ID

UpdateTrustedPeopleStatusDto

statusstring · enum · required
Status of the trusted person
Enum values:
PENDING
APPROVED
REJECTED
REVOKED

TrustedAddress

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
aliasstring · required
Address alias
addressobject · required
Address reference
statusstring · required
Status
requestedByobject · required
Parent who requested the trusted address

alternativeAddressobject
Alternative address reference
reviewedByobject
User who reviewed the trusted address
reviewedByRolestring · enum
Role of the user who reviewed the trusted address
Enum values:
PARENT
DELEGATE
DIRECTOR
TEACHER
ADMINISTRATIVE_COMMUNICATION
ADMINISTRATIVE_LOST_AND_FOUND
ADMINISTRATIVE_PERMISSIONS_MANAGER
SCHOOL_ADMINISTRATOR

TrustedAddressPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

TrustedAddressDto

aliasstring · required
Address alias
familyIdnumber · required
Family ID
addressobject · required
Address data

alternativeAddressobject
Alternative address data
routeIdnumber
Route ID

UpdateTrustedAddressDto

aliasstring
Address alias
alternativeAddressobject
Alternative address data
familyIdnumber
Family ID
addressobject
Address data
routeIdnumber
Route ID

UpdateTrustedAddressStatusDto

statusstring · enum · required
Enum values:
PENDING
APPROVED
DELETED

CreateInvitationDto

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
datestring · date-time · required
Date and time of the invitation event
titlestring · maxLength: 50 · required
Title of the invitation
invitationTypestring · enum · required
Type of invitation (transport route or car)
Enum values:
TRANSPORT_ROUTE
CAR
destinationIdnumber · required
ID of the destination trusted address
hostIdnumber · required
ID of the host student
trustedPeopleIdnumber · required
ID of the trusted people

rejectedBystring · enum
Rejected by parent or school
Enum values:
PARENT
SCHOOL
messagestring · maxLength: 250
Message for the guests
responsibleParentIdnumber
ID of the responsible parent

Invitation

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
datestring · date-time · required
Date and time of the invitation event
titlestring · maxLength: 50 · required
Title of the invitation
invitationTypestring · enum · required
Type of invitation (transport route or car)
Enum values:
TRANSPORT_ROUTE
CAR
statusstring · enum · required
Status of the invitation
Enum values:
PENDING
APPROVED
PARTIALLY_APPROVED
REJECTED

rejectedBystring · enum
Rejected by parent or school
Enum values:
PARENT
SCHOOL
messagestring · maxLength: 250
Message for the guests

InvitationStudentResponse

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
invitationResponseobject · required
Invitation response this student response belongs to
studentobject · required
Student who responded
statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED

InvitationResponse

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
parentobject · required
Parent who responded to the invitation
invitationobject · required
Invitation that was responded to
statusstring · enum · required
Response status
Enum values:
PENDING
ACCEPTED
DECLINED
respondedAtstring · date-time · required
When the parent responded
invitationStudentResponsesobject[] · required
Individual student responses for this invitation response

ExitPermissionWithDetailsDto

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
studentsobject[] · required
List of host student associated with the exit permission
datestring · date-time · required
Permission date
createdByobject · required
User who created the permission
confirmedByTeacherobject · required
Teacher who confirmed the exit
confirmedByAdministrativeobject · required
Administrative who confirmed the exit
confirmedBySchoolAdministratorobject · required
School administrator who confirmed the exit
confirmedAtstring · date-time · required
Confirmed at
statusstring · enum · required
Status
Enum values:
PENDING
APPROVED
REJECTED
CONFIRMED
fixedPermissionobject · required
Fixed permission that generated this exit permission

messagestring
Additional message
Example: Must return by 18:00
qrCodestring
QR Code
Example: data:image/png;base64,....
trustedPersonDetailsobject
Trusted person information for auto-pickup permissions
trustedAddressDetailsobject
Trusted address information for route-change permissions
trustedPersonNamestring
Name of the trusted person (for auto-pickup permissions)
trustedAddressNamestring
Name of the trusted address (for route-change permissions)

InvitationCreatedResponseDto

invitationResponsesobject[] · required
Invitation responses created by the user
exitPermissionsobject[] · required
Exit permissions created by the user with additional details

RespondToInvitationDto

statusstring · enum · required
Response status
Enum values:
PENDING
ACCEPTED
DECLINED
studentIdsnumber[] · required
Student list of Ids

UpdateInvitationDto

idnumber
Id
createdAtstring · date-time
Creation Date
updatedAtstring · date-time
Updated Date
rejectedBystring · enum
Rejected by parent or school
Enum values:
PARENT
SCHOOL
datestring · date-time
Date and time of the invitation event
titlestring · maxLength: 50
Title of the invitation
messagestring · maxLength: 250
Message for the guests
invitationTypestring · enum
Type of invitation (transport route or car)
Enum values:
TRANSPORT_ROUTE
CAR
destinationIdnumber
ID of the destination trusted address
hostIdnumber
ID of the host student
responsibleParentIdnumber
ID of the responsible parent
trustedPeopleIdnumber
ID of the trusted people

UpdateInvitationStatusDto

statusstring · enum · required
Status of the invitation
Enum values:
PENDING
APPROVED
PARTIALLY_APPROVED
REJECTED

RouteAvailability

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
schoolobject · required
School
routeobject · required
Route
datestring · date-time · required
Date for availability tracking
totalCapacitynumber · required
Total capacity of the transport unit
totalRequestednumber · required
Total seats requested (pending + approved permissions and invitations)
totalAvailablenumber · required
Total available seats
totalRejectednumber · required
Total rejected seats
totalAssignednumber · required
Total assigned seats (approved permissions and invitations)
totalPendingnumber · required
Total pending requests (pending permissions and invitations)

RouteAvailabilityPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

RouteAvailabilityDto

schoolobject · required
School
routeobject · required
Route
datestring · date-time · required
Date for availability tracking
totalCapacitynumber · required
Total capacity of the transport unit
totalRequestednumber · required
Total seats requested (pending + approved permissions and invitations)
totalAvailablenumber · required
Total available seats
totalRejectednumber · required
Total rejected seats
totalAssignednumber · required
Total assigned seats (approved permissions and invitations)
totalPendingnumber · required
Total pending requests (pending permissions and invitations)

UpdateRouteAvailabilityDto

schoolobject
School
routeobject
Route
datestring · date-time
Date for availability tracking
totalCapacitynumber
Total capacity of the transport unit
totalRequestednumber
Total seats requested (pending + approved permissions and invitations)
totalAvailablenumber
Total available seats
totalRejectednumber
Total rejected seats
totalAssignednumber
Total assigned seats (approved permissions and invitations)
totalPendingnumber
Total pending requests (pending permissions and invitations)

RouteAvailabilityStudentPaginationDto

dataarray[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

RouteAvailabilityStudent

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
datestring · date-time · required
Date for the route availability
statusstring · enum · required
Status of the student in the route
Enum values:
APPROVED
REJECTED
NO_BOARD
PENDING
studentFirstNamestring · required
Student first name
studentLastNamestring · required
Student last name
levelstring · required
School level of the student
Example: Primary
isFixedPermissionboolean · required
Is this a fixed permission
Default: false

studentSecondLastNamestring
Student second last name
permissionTypestring · enum
Permission type
Enum values:
absence
route-change
no-after-school
auto-pickup
hostFirstNamestring
Host first name
hostLastNamestring
Host last name
hostSecondLastNamestring
Host second last name
destinationRouteobject
Destination route (where the student is going if they are not boarding their original route)
reasonstring
Reason for the status change

RouteAvailabilityStudentDto

datestring · date-time · required
Date for the route availability
statusstring · enum · required
Status of the student in the route
Enum values:
APPROVED
REJECTED
NO_BOARD
PENDING
studentFirstNamestring · required
Student first name
studentLastNamestring · required
Student last name
levelstring · required
School level of the student
Example: Primary
isFixedPermissionboolean · required
Is this a fixed permission
Default: false

studentSecondLastNamestring
Student second last name
permissionTypestring · enum
Permission type
Enum values:
absence
route-change
no-after-school
auto-pickup
hostFirstNamestring
Host first name
hostLastNamestring
Host last name
hostSecondLastNamestring
Host second last name
destinationRouteobject
Destination route (where the student is going if they are not boarding their original route)
reasonstring
Reason for the status change

UpdateRouteAvailabilityStudentDto

datestring · date-time
Date for the route availability
statusstring · enum
Status of the student in the route
Enum values:
APPROVED
REJECTED
NO_BOARD
PENDING
studentFirstNamestring
Student first name
studentLastNamestring
Student last name
studentSecondLastNamestring
Student second last name
levelstring
School level of the student
Example: Primary
permissionTypestring · enum
Permission type
Enum values:
absence
route-change
no-after-school
auto-pickup
hostFirstNamestring
Host first name
hostLastNamestring
Host last name
hostSecondLastNamestring
Host second last name
destinationRouteobject
Destination route (where the student is going if they are not boarding their original route)
isFixedPermissionboolean
Is this a fixed permission
Default: false
reasonstring
Reason for the status change

CronHistory

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
processingTimestring · date-time · required
Time when the processing started
schoolobject · required
School being processed
targetDatestring · date-time · required
Target date for the processed permissions/invitations
statusstring · enum · required
Status of the cron execution
Enum values:
RUNNING
SUCCESS
FAILED

CronHistoryPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

CronHistoryDto

processingTimestring · date-time · required
Time when the processing started
schoolobject · required
School being processed
targetDatestring · date-time · required
Target date for the processed permissions/invitations
statusstring · enum · required
Status of the cron execution
Enum values:
RUNNING
SUCCESS
FAILED

UpdateCronHistoryDto

processingTimestring · date-time
Time when the processing started
schoolobject
School being processed
targetDatestring · date-time
Target date for the processed permissions/invitations
statusstring · enum
Status of the cron execution
Enum values:
RUNNING
SUCCESS
FAILED

LostArticle

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name of article
imgSlugsstring[] · required
Image slugs
createdByAdministrativeobject · required
Administrative who reported lost article
createdBySchoolAdministratorobject · required
School administrator who reported lost article
createdByTeacherobject · required
Teacher who reported lost article
claimedByobject · required
Parent who claimed lost article
deliveredAtstring · date-time · required
Delivered at
statusstring · enum · required
Lost article status
Enum values:
PENDING
CLAIMED
DELIVERED
DELETED
DONATED
categorystring · enum · required
Lost article category
Enum values:
ELECTRONICS
CLOTHING
TOOLS
OTHERS

placestring
Place
descriptionstring
Description article

LostArticlePaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

CreateLostArticleDto

namestring · required
Name of article
imgSlugsstring[] · required
Image slugs
claimedByobject · required
Parent who claimed lost article
statusstring · enum · required
Lost article status
Enum values:
PENDING
CLAIMED
DELIVERED
DELETED
DONATED
categorystring · enum · required
Lost article category
Enum values:
ELECTRONICS
CLOTHING
TOOLS
OTHERS

placestring
Place
descriptionstring
Description article

UpdateLostArticleDto

namestring
Name of article
placestring
Place
descriptionstring
Description article
imgSlugsstring[]
Image slugs
createdByAdministrativeobject
Administrative who reported lost article
createdBySchoolAdministratorobject
School administrator who reported lost article
createdByTeacherobject
Teacher who reported lost article
claimedByobject
Parent who claimed lost article
deliveredAtstring · date-time
Delivered at
statusstring · enum
Lost article status
Enum values:
PENDING
CLAIMED
DELIVERED
DELETED
DONATED
categorystring · enum
Lost article category
Enum values:
ELECTRONICS
CLOTHING
TOOLS
OTHERS

CreateLostArticleReminderDto

lostArticleIdnumber · required
ID of the lost article
reminderDatestring · date-time · required
Date and time when the reminder should be sent

LostArticleReminder

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
reminderDatestring · date-time · required
The date of the reminder

CreateEventReminderDto

eventIdnumber · required
Event ID
Example: 1
reminderDatestring · date-time · required
Reminder date
Example: 2023-05-01T10:00:00Z

ScheduleConfigurationPaginationDto

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

ScheduleConfigurationDto

permissionTimeLimitnumber · required
Number of hours in advance required to request permission
permissionWeeksInAdvancenumber · enum · required
Weeks in advance for receiving permissions
Enum values:
1
2
3
4
Example: 1

UpdateScheduleConfigurationDto

permissionTimeLimitnumber
Number of hours in advance required to request permission
permissionWeeksInAdvancenumber · enum
Weeks in advance for receiving permissions
Enum values:
1
2
3
4
Example: 1

CreateInvitationStudentResponseDto

invitationResponseIdnumber · required
Invitation response ID
Example: 1
studentIdnumber · required
Student ID
Example: 1
statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED
Example: ACCEPTED

UpdateInvitationStudentResponseDto

statusstring · enum · required
Student response status
Enum values:
ACCEPTED
DECLINED
Example: ACCEPTED

RulesTransportationContentResponseDto

contentstring · required
HTML with the transportation rules

UpdateRulesTransportationContentDto

contentstring · required
HTML with the transportation rules

TransportationSummaryStatusDto

routeChangenumber · required
Count of route change requests
Example: 2
noAfterSchoolnumber · required
Count of no after school requests
Example: 2
autoPickupnumber · required
Count of auto pickup requests
Example: 2
absencenumber · required
Count of absence requests
Example: 2
transportInvitationnumber · required
Count of transport invitations
Example: 2
autoInvitationnumber · required
Count of auto invitations
Example: 2