website·Indexed 30 days ago
https://developers.ehgqa.comAPI documentation for Zunia, providing endpoints to manage student data, including current, past, and future students, medical conditions, legal information, and photo permissions. It also includes a comprehensive set of lookup endpoints for school-related metadata such as visa classes, qualification levels, transport types, and staff employment types.
getTeacher endpoint to retrieve detailed information about a specific teacher. The request requires a unique UUID for the teacher in the path parameter.GET /ims/oneroster/v1p1/teachers/:teacherIdGET /lookup/interview-outcome endpoint to retrieve a list of available lookup values for interview outcomes. The response returns a data object containing a list of options, each providing detailed metadata about the outcome, including its unique ID, code, display title, and associated interview type.// Example Response Schema
{
"code": "string", // Status Code
"data": {
"name": "string",
"displayName": "string",
"options": [
{
"id": "uuid",
"description": "string",
"code": "string",
"sortOrder": 0,
"active": true,
"value": "string",
"title": "string",
"interviewTypeId": "uuid",
"interviewTypeDescription": "string"
}
]
}
}The API returns a JSON object containing the following key data structures:
givenName, surname, prefName), birth date, gender, and deceased status.companyName and schoolId.addresses with systemMeaning (e.g., 'Postal' or 'Home'), street details, postalCode, and formatted display strings (displayAddressComma, displayAddressFull).emailAddress, phoneNumber (with phoneType and countryCode), and internetAndSocialMedia links.religion, indigenousStatus, parish, region, birthCountry, homeLanguages, and nationalities.company, industry, occupation title, and positionCategory.education level, qualifications, lastYearOfStudy, and qualification levels (secondary, highest, and non-national).GET /lookup/transport-stop endpoint to retrieve a list of lookup values for transport stops. The response returns a JSON object containing a list of options, each providing detailed metadata about a transport stop, including its unique identifier, description, sort order, and associated transport type information.GET /lookup/transport-stopGET /lookup/other-requirement endpoint to retrieve a list of lookup values associated with other requirements. The response is returned as application/json and contains a data object with a list of options, each including a unique identifier, description, code, sort order, active status, value, and title.{
"code": "string",
"data": {
"name": "string",
"displayName": "string",
"options": [
{
"id": "uuid",
"description": "string",
"code": "string",
"sortOrder": 0,
"active": true,
"value": "string",
"title": "string"
}
]
}
}To authenticate with the Zunia OneRoster API, you must first generate an API key. When creating the key, select the 'Advanced' option and ensure the GET, PUT, and DELETE HTTP verbs are selected. You must also assign a permissions group containing the required scopes. Available permissions include:
The /lookup/dietary-requirement endpoint returns a JSON response with the following structure:
code (string, required): The status or identifier code.data (object):name (string, required): The internal name of the lookup.displayName (string, required): The human-readable name of the lookup.options (array, required): A list of dietary requirement options, each containing:id (uuid, required): Unique identifier for the option.description (string, required): Detailed description of the requirement.code (string, required): Technical code for the requirement.sortOrder (number, required): The display order of the option.active (boolean, required): Whether the option is currently active.value (string, required): The value of the requirement.title (string, required): The display title of the requirement.Authorization header as a Bearer token for all subsequent API requests.HOST=public-api-ap-se-2.zunia.com
ACCESS_TOKEN=<ACCESS_TOKEN>
curl --location "https://$HOST/ims/oneroster/v1p1/students" \
--header "Accept: application/json" \
--header "Authorization: Bearer $ACCESS_TOKEN"# Step 1: Obtain an access token
TOKEN_URL=https://auth.zunia.com/oauth2/token
CLIENT_ID=YOUR_CLIENT_ID
CLIENT_SECRET=YOUR_CLIENT_SECRET
curl --request POST \
--url $TOKEN_URL \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data grant_type=client_credentials \
--data client_id=$CLIENT_ID \
--data client_secret=$CLIENT_SECRET
# Step 2: Use the access token to call an endpoint
HOST=public-api-ap-se-2.zunia.com
curl "https://$HOST/api/v2/students/current" \
-H "Authorization: Bearer {ACCESS_TOKEN}"The /lookup/physical-requirement endpoint returns a JSON response with the following structure:
code (string, required): The status or identifier code.data (object): Contains the lookup details:name (string, required): The internal name of the requirement.displayName (string, required): The human-readable name.options (array, required): A list of available options, each containing:id (uuid, required): Unique identifier for the option.description (string, required): Detailed description of the option.code (string, required): The option code.sortOrder (number, required): The sequence order for display.active (boolean, required): Whether the option is currently active.value (string, required): The value of the option.title (string, required): The display title of the option.