Tool Search: Ed-Fi
This entity represents the physical space where students gather for a particular class/section. The location may be an indoor or outdoor area designated for the purpose of meeting the educational needs of students.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a new Room is created and saved.
|
| Post | When a Room Name is changed and saved. |
| Put | When the room number changes. |
| Delete | When a Room is deleted. |
| Delete/Post | When a Room Name is changed and saved. |
| Delete/Post | When there are two rooms with the same natural key and 1 is deleted, the other record will post with the remaining records data. |
School Exclude, Calendar Exclude, Resource Toggle and Resync Logic
This table describes the School Exclude, Calendar Exclude, Resource Toggle and Resync logic of this object.
| Action | Trigger |
|---|---|
| None | If a resource is toggled to 'OFF' after data has sent, all sent data will remain in the ODS but no new data will send. |
| Delete | If a resource is toggled to 'OFF" after data has sent and an action is performed that would trigger a delete, that data will remain in the ODS until a resync is done. |
| Resync | If a record is in the Ed-Fi Identity Mapping table and not in the ODS, it will be deleted from the Ed-Fi Identity Mapping table. |
| Resync | If a record is in the ODS and it does not have a matching record in Campus or the Ed-Fi Identity Mapping table, it will be deleted from the ODS. |
| Resync | If a mapping is changed in Resource Preferences, a resync will need to be done to reflect the changes. |
Natural Key Changes, Cascading Updates, and Deletes Logic
This table describes the Natural Key Changes/Cascading Updates and Deletes logic of this object.
| Action | Trigger |
|---|---|
| Delete/Post | If any of the following changes in the Schools resource:
|
| Delete/Post | If the Room Name changes. |
Scope Year Logic
| Logic |
|---|
| Rooms are not aligned to a year so all Rooms will send to each scoped year. |
| Data will only send for years that have valid configuration. |
Event Queue Detail
| Campus Table | Ed-Fi Action | Fields |
|---|---|---|
| rooms | Post/Put/Delete | The primary table used for sending data for this resource. |
Object Data Elements
This table describes data elements sent within the Locations resource.
| Data Element Label | Business Requirement | Business Rules | M, C or O | Location |
|---|---|---|---|---|
| id | The unique identifier of the resource. |
| M | |
| classroomIdentificationCode | A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity. | Reports the Room Name. | M | System Administration > Resources > Resources > Rooms room.name |
| schoolReference | A reference to the related School resource. | Reports the fields that are part of the Natural Key for the School resource. | M | System Administration > Resources > School > State School Number System Administration > Resources > District Information > State District Number district.Number school.number |
| maximumNumberOfSeats | The highest number of seats the class can maintain. |
| O | System Administration > Resources > Resources > Capacity room.capacity |
| optimalNumberOfSeats | The number of seats that is most favorable to the class. | Optional, does not report. | O | |
| _etag | A unique system-generated value that identifies the version of the resource. | Optional, does not report. | O |
