For Developers
School Enrollment Roles Overview
This model is part of the v2.5 API update which is currently in beta and therefore subject to change.
School Enrollment Roles map district/school-defined person/user role definitions to Edlink's standardized PersonRole enumeration.
Properties
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the object. $filter operators: equals in not in |
created_date | Date | When the object was first seen by Edlink. |
updated_date | Date | When the object was last changed in Edlink. $filter operators: equals gt lt gte lte |
code | string | The code. |
name | string | The name of the user role. |
description | string | The description of the user role. |
mapping | PersonRole | The standardized person role mapping. |
JSON Example
{
"id": "00000000-0000-0000-0000-000000000000",
"created_date": "2021-07-05T20:32:40.454Z",
"updated_date": "2021-07-12T21:44:23.126Z",
"code": "STG5",
"name": "Staff - Teacher - Grade 5",
"description": "A teacher of classes for 5th grade students.",
"mapping": "teacher"
}