An Agent describes the relationship between two people, and is typically used to represent a connection between a student and their parent or guardian. If a data source provides emergency contacts, this is how they are represented in Edlink.
Properties
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the object. $filter operators: equals in not in |
relationship | Relationship | The relationship between the observer and the target. |
flags | AgentFlag[] | Flags associated with the agent. |
properties | object | Non-standard properties that may be of interest to the developer. |
identifiers | Identifier[] | Additional IDs associated with the object. |
observer_id | string | The UUID of the Person who acts as the observer in the relationship. Typically, this is a parent or guardian. $expand: observer$filter operators: equals in not in |
target_id | string | The UUID of the Person who acts as the target in this relationship. Typically, this is a student. $expand: target$filter operators: equals in not in |
JSON Example
{
"id": "00000000-0000-0000-0000-000000000000",
"relationship": "parent",
"properties": {},
"observer_id": "00000000-0000-0000-0000-000000000000",
"target_id": "00000000-0000-0000-0000-000000000000",
"flags": []
}