An Edlink Institution represents a learning organization in the Public Data API, such as a school, district, college, or university. Institutions can be linked to one another through parent/child relationships.
Properties
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the object. $filter operators: equals in not in |
name | string | The institution's name. $filter operators: equals starts with contains in not in is known is unknown |
type | string | The institution type. One of school, district, college, university, lea, government, organization, or other. See the Data Standardization SOP for how source labels map into these values.$filter operators: equals in not in is known is unknown |
descriptor | string | A short label or qualifier for the institution. $filter operators: equals starts with contains in not in is known is unknown |
website | string | The institution's website URL. $filter operators: equals starts with contains in not in is known is unknown |
description | string | A longer description of the institution. $filter operators: equals starts with contains in not in is known is unknown |
logo | string | A URL for the institution's logo. |
addresses | Address[] | The institution's addresses. |
children | Institution[] | The institution's child entities. |
Address Properties
Each entry in addresses has the following properties:
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the address. |
type | string | The address type. One of physical, mailing, post_office_box, billing, shipping, headquarters, branch, or other. |
street | string | The street address. |
unit | string | The unit, suite, or apartment number. |
postal_code | string | The postal or ZIP code. |
city | string | The city. |
state | string | The full state or province name (for example California, not CA). See the Data Standardization SOP. |
country | string | The English CLDR country name (for example United States, not US). See the Data Standardization SOP. |
latitude | number | The latitude coordinate. |
longitude | number | The longitude coordinate. |
Parent/Child Relationships
Institutions can be linked in parent/child hierarchies, such as a school belonging to a district. Use Get Institution (or expand children when calling List Institutions) to retrieve an institution along with its parent and children.
JSON Example
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Lincoln Elementary School",
"type": "school",
"descriptor": null,
"website": "https://lincoln.example.edu",
"description": "A public elementary school serving grades K-5.",
"logo": null,
"addresses": [
{
"id": "11111111-1111-1111-1111-111111111111",
"type": "physical",
"street": "123 Main Street",
"unit": null,
"postal_code": "62701",
"city": "Springfield",
"state": "Illinois",
"country": "United States",
"latitude": 39.7817,
"longitude": -89.6501
}
]
}