Download OpenAPI specification:
Repairs the ACL for any parse object (except for _User, then use repairUserACL instead.) It repairs the school based read permission in the ACL. It will also repair, the permission of an owner (User), if given, with both read and write, if param userId is supplied. NOTE: For the supporter app to be aware of the object to repair, it need access rights to it.
| className required | string The class name of the parse object to repair |
| objId required | string The object Id of the parse object to repair |
| schoolId required | string The school Id of the object to repair |
| roleCodes required | string The role codes to restore in the ACL, can be "a", "t", "ts", "p" |
| userId required | string The User Id to restore in the ACL as a User permission, typically an owner, read and write. If the User restore should be skipped, skip this parameter. |
{- "className": "string",
- "objId": "string",
- "schoolId": "string",
- "roleCodes": "string",
- "userId": "string"
}nullMark an active absence as completed.
| absenceId required | string |
| kidId required | string |
| includeToday required | boolean |
| sendPush | boolean |
{- "absenceId": "string",
- "kidId": "string",
- "includeToday": true,
- "sendPush": true
}{ }Add a new active or future absence
| startDate required | string Start date (YYYY-MM-DD) |
| endDate required | string End date (YYYY-MM-DD) |
| schoolId required | string School ID |
| kidId required | string Kid ID |
| sendPush | boolean=true Whether to send push notification |
{- "startDate": "string",
- "endDate": "string",
- "schoolId": "string",
- "kidId": "string",
- "sendPush": null
}{ }Add a historic absence
| startDate required | string Start date (YYYY-MM-DD) |
| endDate required | string End date (YYYY-MM-DD) |
| schoolId required | string School ID |
| kidId required | string Kid ID |
{- "startDate": "string",
- "endDate": "string",
- "schoolId": "string",
- "kidId": "string"
}{ }Lock / Unlock an absence. When locked, edits to the absence are not allowed.
| absenceId required | string Absence ID |
| confirmed required | boolean Whether the absence is confirmed or not |
{- "absenceId": "string",
- "confirmed": true
}{ }Delete historic, active or future absence
| absenceId required | string Absence id |
| kidId | string Kid id |
{- "absenceId": "string",
- "kidId": "string"
}{ }Edit active or future absence
Note: Historic absence is NOT editable
| absenceId required | string Absence id |
| startDate required | string Start date (YYYY-MM-DD) |
| endDate required | string End date (YYYY-MM-DD) |
| info | string Info about absence |
| sendPush | boolean Whether to send push notification |
{- "absenceId": "string",
- "startDate": "string",
- "endDate": "string",
- "info": "string",
- "sendPush": true
}{ }get all active & future absences for a school
| schoolId required | string School ID |
| webCall | boolean True if executing client is a React app |
{- "schoolId": "string",
- "webCall": true
}{ }Get all active & future absences for specific Kid
| schoolId required | string School ID |
| kidId required | string Kid ID |
| excludeAnonymous required | boolean Exclude anonymous users |
{- "schoolId": "string",
- "kidId": "string",
- "excludeAnonymous": true
}{ }Get Historic Absence on a child
| kidId required | string Object ID of the kid to get historic absence for. |
| includeUser required | boolean If user element should be the full Parse Object for user, or just the object ID. (Default is just object ID) |
{- "kidId": "string",
- "includeUser": true
}{ }Send reminder about absence to guardians
| kidId required | string Kid ID |
| absenceID required | string Absence ID |
{- "kidId": "string",
- "absenceID": "string"
}{ }Fetches contact profiles for a school, scoped by the caller’s UserRole.
Returned contacts are filtered and redacted based on:
Multiple UserRoles pointing to the same person are merged, and all related kid pointers are aggregated into a single contact entry.
| roleId required | string ObjectId of the caller’s UserRole. |
| kidId | string ObjectId of a kid to filter by. |
{- "roleId": "string",
- "kidId": "string"
}{ }[object Object],[object Object],[object Object]
| schoolId required | string School id to fetch events for. |
| userRoleId | string UserRole id used for authorization and context. If omitted, the first role for the school is used. |
| dateStart | string Inclusive start date (YYYY-MM-DD). See defaults above. |
| dateEnd | string Inclusive end date (YYYY-MM-DD). See defaults above. |
| departmentIds | string[] Only return events for these department ids. |
| tagsIds | string[] Only return events matching these tag ids. |
| kidsIds | string[] Only return events involving these kid ids. |
| eventTypes | string[] Only return events of these types. |
| eventGroupInfoId | string Only return events belonging to this group info id. |
| eventVisibility | staffeventsread Visibility level used when selecting staff events. |
{- "schoolId": "string",
- "userRoleId": "string",
- "dateStart": "string",
- "dateEnd": "string",
- "departmentIds": null,
- "tagsIds": null,
- "kidsIds": null,
- "eventTypes": null,
- "eventGroupInfoId": "string",
- "eventVisibility": null
}{ }Will check in or check out a list of kids. Several options can be attached. To be used to check in or out even a single kid.
Will also save Log (kids log) and Notification. If sendPush, push notification is sent.
| schoolId required | string School id. |
| kidIds required | string[] Array of ids of Kids to check in or out. |
| isCheckIn required | boolean Whether to check in, othewise check out. |
| modifiedCheckInOutTime required | date|undefined An alternative timestamp for check in or out. If not defined, current time is used. To use for instance it the staff forgot to do it. |
| pickupUserRoleIds required | (string|null)[] People, in the form of UserRole ids (connected to User or AlternativeContact), which will be assigned to pick up the kid at end of school day. One entry for each kid, if a certain kid will not have a pickuper assigned, set the value to null. The array is allowed to be empty or shorter than the kid id list. |
| pickupTime required | string A new pickutime to be assigned for each kid in kidIds. |
| performerId required | string The UserRole which did perform the check in or out. Used for notices and push. |
| sendPush required | boolean Whether push should be sent afterwards. |
{- "schoolId": "string",
- "kidIds": null,
- "isCheckIn": true,
- "modifiedCheckInOutTime": null,
- "pickupUserRoleIds": null,
- "pickupTime": "string",
- "performerId": "string",
- "sendPush": true
}nullAdjusts one of the three available checkinout notes for a kid.
| schoolId required | string School id. |
| kidId required | string Kid id to adjust checkinout note for. |
| noteType required | kid_note_type The type of note to adjust. |
| remove required | boolean If true the note will be removed instead of set. |
| comment required | string|undefined Content of the note to be set. |
| sendPush required | boolean Whether push should be sent afterwards. |
{- "schoolId": "string",
- "kidId": "string",
- "noteType": null,
- "remove": true,
- "comment": null,
- "sendPush": true
}nullAdjusts the pickup time and person who will pick up the kid.
| schoolId required | string School id. |
| kidId required | string Kid id to perform the operation for. |
| pickupUserRoleId required | string|undefined UserRoleid (connected to User or AlternativeContact), which will be assigned to pick up the kid at end of school day. |
| pickupTime required | string A new pickup time to be assigned to the kid. |
| performerId required | string The UserRole which did perform the operation. Used for notices and push. |
| sendPush required | boolean Whether push should be sent afterwards. |
{- "schoolId": "string",
- "kidId": "string",
- "pickupUserRoleId": null,
- "pickupTime": "string",
- "performerId": "string",
- "sendPush": true
}nullInitiates a login session between client and server.
Possible login actions include:
| username required | string Username of the person trying to log in. |
| loginMethod required | number Username type (email, phone, nin) |
| clientType required | string Client platform (Web, Android iOS, supporter) |
| chosenId | string User's objectId (if already selected by loginAction.Choice) |
{- "username": "string",
- "loginMethod": 0,
- "clientType": "string",
- "chosenId": "string"
}{ }Creates a new Person object.
| givenName required | string The person's given name. |
| familyName required | string The person's family name. |
| displayName | string The person's display name. |
| civicNo | string The person's civic number. |
string The person's email address. | |
| emailType | emailtype The person's email type. |
| phone | string The person's phone number. |
| phoneType | phonenumbertype The person's phone type. |
| streetAddress | string The person's street address. |
| locality | string The person's locality. |
| postalCode | string The person's postal code. |
| country | string The person's country. |
| loginMethod | user_type The preferred login method. |
| userId | string The user ID to link to the person. |
| schoolId required | string The school ID. |
{- "givenName": "string",
- "familyName": "string",
- "displayName": "string",
- "civicNo": "string",
- "email": "string",
- "emailType": null,
- "phone": "string",
- "phoneType": null,
- "streetAddress": "string",
- "locality": "string",
- "postalCode": "string",
- "country": "string",
- "loginMethod": null,
- "userId": "string",
- "schoolId": "string"
}"string"Finds a person object for a school
| username | string The username for the person. |
| userId | string The objectId for a user to search for. |
| schoolId required | string ObjectId for the school. |
{- "username": "string",
- "userId": "string",
- "schoolId": "string"
}nullValidate user-input for creating a person object
| territory | number School territory (only used for civicNo validation) |
string Email address to validate | |
| phone | string Phone number to validate |
| civicNo | string Civic Number (NIN) to validate |
{- "territory": 0,
- "email": "string",
- "phone": "string",
- "civicNo": "string"
}nullCreates a user role for a given person based on the provided role type.
Supported role types:
If req.params.personUUID is not provided, the function attempts to look up the Person using req.params.userId.
| personUUID | string The UUID of the Person. |
| userId | string The objectId of the User to link if personUUID isn't provided. |
| schoolId required | string The objectId of the School. (required) |
| roleNum required | number The role number (USER_ROLE_TYPE). (required) |
| title | string Optional title for the role. |
| department | string The objectId of the Department. |
| kidId | string The objectId of the Kid, for parent role. |
| configuration | string Serialized configuration for the role. |
| directActivation | boolean Whether to activate the role immediately. |
{- "personUUID": "string",
- "userId": "string",
- "schoolId": "string",
- "roleNum": 0,
- "title": "string",
- "department": "string",
- "kidId": "string",
- "configuration": "string",
- "directActivation": true
}"string"Create a new school
| display_school_name required | string Display name of the school |
| timezone required | string IATA time zone of the school |
| territory required | number ISO 3166-1 numeric country code |
| organisation_id | string SS12K org ID |
| organisation_context_id | string SS12K org context ID |
| pipedrive_deal_id | string Pipedrive Deal ID |
{- "display_school_name": "string",
- "timezone": "string",
- "territory": 0,
- "organisation_id": "string",
- "organisation_context_id": "string",
- "pipedrive_deal_id": "string"
}{ }Used to request a "forgot password" email for the user. Can be used without being authenticated.
| username required | string Username for the user requesting a new password. |
{- "username": "string"
}{ }Delete a user role
| userRoleId required | string The ObjectID of the user role to delete. |
| deletedByMyself | boolean Whether the function is called by the user role owner or not. |
| sendPush | boolean Whether to send push notification. |
{- "userRoleId": "string",
- "deletedByMyself": true,
- "sendPush": true
}{ }Delete of own user role.
| userRoleId required | string User Role to delete. |
| sendPush | boolean Whether to send push notification. |
{- "userRoleId": "string",
- "sendPush": true
}{ }Cloud function to find existing users by searching for existing records using NIN, email, or phone. It returns matched user data, with anonymization for non-matching fields.
| nin | string National Identification Number. |
string Email of the user. | |
| phone | string Phone number of the user. |
{- "nin": "string",
- "email": "string",
- "phone": "string"
}nullSet NIN for initiator
| nin | string|undefined Param nin can be a string or undefined, in which case it is unset in the db. This is considered the users choice to not submit a nin. |
| territory required | number the territory of the nin, despite the Users territory. |
{- "nin": null,
- "territory": 0
}{ }Verify that a given password matches the user's password. Mainly used to authorize sensitive actions in the app.
| password required | string The user-supplied password |
{- "password": "string"
}true