For Developers
Facilities Overview
A facility is a physical location that is associated with a School or Department. A facility can be a building, a room, a lab, or any other physical location. Facilities are used to track the location of students, staff, and equipment. Facilities contain Rooms.
Properties
Property | Type | Description |
---|---|---|
id | string | The UUID for the facility. $filter operators: equals in not in |
created_date | Date | When the facility was first seen by Edlink. |
updated_date | Date | When the facility was last changed in Edlink. $filter operators: equals gt lt gte lte |
properties | object | Non-standard properties that may be of interest to the developer. |
name | string | The name of the facility. |
description | string | A description of the facility. |
type | FacilityType | The type of the facility. |
flags | FacilityFlag[] | The flags for the facility. All, some, or none of the possible flags may be included. |
address | Address | The address location of the facility. |
identifiers | Identifier[] | Additional IDs associated with the object. |
school_ids | string[] | An array of UUIDs of the associated Schools. |
department_ids | string[] | An array of UUIDs of the associated Departments. |
JSON Example
{
"id": "00000000-0000-0000-0000-000000000000",
"created_date": "2021-07-13T17:45:27.570Z",
"updated_date": "2021-07-13T17:45:27.570Z",
"properties": {},
"name": "The Marie Curie Science Center.",
"description": "A description of the facility.",
"type": "lab",
"flags": ["under_construction"],
"address": {
"street_address": "123 Main St",
"unit_number": "Apt 456",
"city": "Anytown",
"state": "CA",
"postal_code": "12345",
"country": "USA",
"phone": "555-123-4567",
"latitude": 37.7749,
"longitude": -122.4194
},
"school_ids": [],
"department_ids": []
}