Get all administrative users with pagination
Retrieve a paginated list of administrative users based on query parameters
query Parameters
pagenumberCurrent page
pageSizenumberPage size
Responses
dataobject[] · requiredData
pagenumberCurrent page
pageSizenumberPage size
totalnumberTotal
lastPagenumberLast page
nextstringNext page (endpoint)
previousstringPrevious page (endpoint)
Create a new administrative user
Create a new administrative user with the provided data
Request Body
levelsstring[] · requiredSchool levels
Example: ["Primary"]lastNamestring · requiredLast name of the administrative
Example: DoefirstNamestring · requiredFirst name of the administrative
Example: JanesecondLastNamestring · requiredSecond last name of the administrative
Example: SmithbirthDatestring · date-time · requiredBirth date of the administrative
Example: 1980-02-01T12:30:00.000Zphonestring · requiredPhone
Example: +523517892545administrativeRolesstring[] · requiredAdministrative role assigned
Enum values:ADMINISTRATIVE_COMMUNICATIONADMINISTRATIVE_LOST_AND_FOUNDADMINISTRATIVE_PERMISSIONS_MANAGERDIRECTORADMINISTRATIVE_TRANSPORTSCHOOL_ADMINISTRATOR
emailstringEmail of administrative
Default: email@administrative.com
Responses
Administrative created
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
levelsstring[] · requiredSchool levels
Example: ["Primary"]lastNamestring · requiredLast name of the administrative
Example: DoefirstNamestring · requiredFirst name of the administrative
Example: JanesecondLastNamestring · requiredSecond last name of the administrative
Example: SmithbirthDatestring · date-time · requiredBirth date of the administrative
Example: 1980-02-01T12:30:00.000Z
Get administrative user by ID
Retrieve a specific administrative user by its ID
path Parameters
idnumber · min: 1 · requiredId
Responses
Administrative detail
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
levelsstring[] · requiredSchool levels
Example: ["Primary"]lastNamestring · requiredLast name of the administrative
Example: DoefirstNamestring · requiredFirst name of the administrative
Example: JanesecondLastNamestring · requiredSecond last name of the administrative
Example: SmithbirthDatestring · date-time · requiredBirth date of the administrative
Example: 1980-02-01T12:30:00.000Z
Update an administrative user
Update an existing administrative user by its ID
path Parameters
idnumber · min: 1 · requiredId
Request Body
levelsstring[]School levels
Example: ["Primary"]lastNamestringLast name of the administrative
Example: DoefirstNamestringFirst name of the administrative
Example: JanesecondLastNamestringSecond last name of the administrative
Example: SmithbirthDatestring · date-timeBirth date of the administrative
Example: 1980-02-01T12:30:00.000Z
Responses
Administrative updated