A Person within a data source.
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 |
first_name | string | The person's first name. $filter operators: equals starts with contains in not in is known is unknown |
middle_name | string | The person's middle name. |
last_name | string | The person's last name. $filter operators: equals starts with contains in not in is known is unknown |
display_name | string | The person's display name. $filter operators: equals starts with contains in not in is known is unknown |
picture_url | string | The URL for the person's profile picture. |
roles | Role[] | The person's roles. Note that not every data source has roles for a person. |
email | string | The person's email address. Many data sources do not require any sort of email verification for this field, so use caution. $filter operators: equals starts with contains |
phone | string | The person's phone number. |
locale | string | The locale of the object. |
time_zone | Timezone | The tz database name of the object. |
gpa | number | The person's GPA. |
letter_grade | string | The person's overall letter grade. |
graduation_year | number | The person's expected graduation year. |
grade_levels | GradeLevel[] | The grade levels this person is associated with. |
demographics | Demographics | The person's demographics. |
address | Address | The person's primary address. |
properties | object | Non-standard properties that may be of interest to the developer. |
identifiers | Identifier[] | Additional IDs associated with the object. |
district_id | string | The UUID of the associated District. |
school_ids | string[] | The UUIDs of the associated Schools. |
department_ids | string[] | The UUIDs of the associated Departments. |
route_ids | string[] | The UUIDs of the associated bus Routes. |
JSON Example
{
"id": "00000000-0000-0000-0000-000000000000",
"created_date": "2021-07-13T17:45:39.937Z",
"updated_date": "2021-07-13T17:45:39.937Z",
"first_name": "George",
"middle_name": "Oscar",
"last_name": "Bluth",
"display_name": "Gob Bluth",
"picture_url": "https://static.wikia.nocookie.net/arresteddevelopment/images/7/79/GOB_on_segway.jpg",
"roles": ["student"],
"email": "gob.bluth@example.com",
"phone": "12345556789",
"locale": "en",
"time_zone": "America/Los_Angeles",
"graduation_year": 1996,
"grade_levels": ["PS"],
"demographics": {},
"address": {},
"properties": {},
"district_id": "00000000-0000-0000-0000-000000000000",
"school_ids": ["00000000-0000-0000-0000-000000000000"],
"department_ids": ["00000000-0000-0000-0000-000000000000"],
"route_ids": ["00000000-0000-0000-0000-000000000000"]
}