The SIMS API has been updated to add two new endpoints, add some new query parameters, and update some responses to include additional fields. The updates are listed below. No existing fields are impacted by the additions.
All Updates
| Endpoint | Query Parameter Additions | Response Additions | Resource Definition Section | Other change notes |
|---|---|---|---|---|
| /buildings | Added buildid, buildname, campusname, and buildingstatus | Added buildingType, viewerLink, buildingOwnership, landOwnership, buildingLeaseType, landLease, and plansRestricted | Buildings | Store model and descriptions updated |
| /buildings/{buildingNumber} | Added buildingType, viewerLink, buildingOwnership, landOwnership, buildingLeaseType, landLease, and plansRestricted | Buildings | Store model and descriptions updated | |
| /buildings/delta/{days} | Added campusname | Added buildingType, viewerLink, buildingOwnership, landOwnership, buildingLeaseType, landLease, and plansRestricted | Buildings | Store model and descriptions updated |
| /floors | Added campusname | Added buildingNumber, and viewerLink | Floors | Store model and descriptions updated |
| /buildings/{buildingNumber}/floors | Added buildingNumber, and viewerLink | Floors | Store model and descriptions updated | |
| /floors/delta/{days} | Added campusname | Added buildingNumber, and viewerLink | Floors | Store model and descriptions updated |
| /rooms | Added campusname, floorname, and spaceid | Added buildingNumber, costCenterConcat, occupantCCConcat, and viewerLink | Rooms | Store model and descriptions updated |
| /buildings/{buildingNumber}/rooms | Added buildingNumber, costCenterConcat, occupantCCConcat, and viewerLink | Rooms | Store model and descriptions updated | |
| /rooms/delta/{days} | Added campusname | Added buildingNumber, costCenterConcat, occupantCCConcat, and viewerLink | Rooms | Store model and descriptions updated |
| /occupants | Added campusname | Store descriptions updated | ||
| /archive-docs | Added campusname | Store descriptions updated | ||
| /allocation-by-cc | Added campusname | Store descriptions updated | ||
| /allocation-by-function | Added campusname | Store descriptions updated | ||
| /allocation-by-roomtype | Added campusname | Store descriptions updated | ||
| /image-locations | Added locationbuildid, campusname, spaceid, imagetype, and defaultimage | Added ImageName, FileName, Comment, UploadedDate, UploadedBy, FileType, 360Image, DocumentLink, ViewerLink, LocationType, SpaceID, CampusName, LocationBuildingNumber, LocationBuildingName, FloorName, RoomNumber, LocationPhotoCount, and DefaultImage | Image-Locations | |
| /space-groups | Added buildid, campusname, and groupcategory | Added GroupName, Comment, GroupCategory, GroupClass, GroupSubClass, ExpirationDate, SpaceID, CampusName, BuildingNumber, BuildingName, FloorName, RoomNumber, and Area | Space-Groups |
Buildings Resources Addition Definitions
| Field | Definition |
|---|---|
| buildingType | whether a record is considered a building or structure |
| viewerLink | link to viewer of default photo for the object record, if applicable (SIMS account required) |
| buildingOwnership | building owner (*see note) |
| landOwnership | land owner (*see note) |
| buildingLeaseType | type of OSU lease (*see note) |
| landLease | t/f OSU land lease (*see note) |
| plansRestricted | t/f whether floor plans are restricted |
*NOTE: Added to the API in coordination with the upcoming ownership tracking changes.
Floors Resources Additions Definitions
| Field | Definition |
|---|---|
| buildingNumber | building number |
| viewerLink | link to viewer of default photo for the object record, if applicable (SIMS account required) |
Rooms Resources Additions Definitions
| Field | Definition |
|---|---|
| buildingNumber | building number |
| costCenterConcat | single text string that lists all cost centers with allocated area in that record and the percentage concatenated with “=” and “;”, no spaces added
|
| occupantCCConcat | single text string that lists all cost centers allocated as occupant CCs in that record and the percentage concatenated with “=” and “;”, no spaces added
|
| viewerLink | link to viewer of default photo for the object record, if applicable (SIMS account required) |
Image-Locations Resource Additions Definitions
(NOTE: listed by association, so an image associated with 8 rooms will have 8 rows in the response)
| Field | Definition |
|---|---|
| ImageName | name of image record in SIMS |
| FileName | name of file in SIMS |
| Comment | comment on file in SIMS |
| UploadedDate | date uploaded |
| UploadedBy | person who uploaded the photo |
| FileType | type of photo file |
| 360Image | t/f whether the photo is a 360 image |
| DocumentLink | link to downloadable photo (SIMS account required) |
| ViewerLink | if 360 photo, link to 360 photo viewer; otherwise DocumentLink (SIMS account required) |
| LocationType | type of location image is associated with in this record |
| SpaceID | spaceID image is associated with, if applicable |
| CampusName | campus of location image is associated with, if applicable |
| LocationBuildingNumber | building or asset number image is associated with, if applicable |
| LocationBuildingName | building or asset name image is associated with, if applicable |
| FloorName | floor name image is associated with, if applicable |
| RoomNumber | room number image is associated with, if applicable |
| LocationPhotoCount | total count of photos at the location |
| DefaultImage | t/f whether record is the default for the location |
Space-Groups Resource Additions Definitions
(NOTE: listed by association, so a group associated with 8 rooms will have 8 rows in the response)
| Field | Definition |
|---|---|
| GroupName | name of group with ID in parentheses, typically one of the following structures:
|
| Comment | comment about record in SIMS |
| GroupCategory | type of space group, such as MOU, Executed Lease, or Program |
| GroupClass | currently not populated |
| GroupSubClass | currently not populated |
| ExpirationDate | date agreement expires, if applicable |
| SpaceID | spaceID of space group is associated with |
| CampusName | campus of space group is associated with |
| BuildingNumber | building number of space group is associated with |
| BuildingName | building name of space group is associated with |
| FloorName | floor name of space group is associated with |
| RoomNumber | room number of space group is associated with |
| Area | area of space group is associated with |