Rooms API

Product Experience Team

June 12, 2023 17:17

The Rooms API returns all rooms imported from the SIS effective within a specified date range.

Within the specified date range, the API returns:

Room Code
Building Code
Campus Code
Room ID
Room Name
Building Name

Campus Name
Room Description
Building Description
Campus Description
Capacity
Room Type

Endpoint

https://tn3dz47ox6.execute-api.us-east-1.amazonaws.com/v1-prod/rooms

REST Verb

GET

Query Parameters

startDate –

Defines the beginning of the date range of rooms to retrieve
Format: YYYY-MM-DD

endDate –

Defines the end of the date range of rooms to retrieve
Format: YYYY-MM-DD

campusCode (optional) –

Limits the result set to the campus specified
Format: case sensitive string

buildingCode (optional) –

Limits the result set to the building specified
Format: case sensitive string

Query Example

https://kr1r51itec.execute-api.us-east-1.amazonaws.com/v0-prod/activities?startDate=2022-09-22&endDate=2022-09-29&campusCode=1&buildingCode=ATC

Results Example

[
    {
        "roomId": "ATC_110B-A_202202",
        "roomCode": "110B-A",
        "buildingCode": "ATC",
        "campusCode": "1",
        "roomName": "110B-A",
        "buildingName": "ATC",
        "campusName": "1",
        "campusDescription": "Wheeling",
        "buildingDescription": "ATC",
        "roomDescription": "HVAC Classroom",
        "capacity": 15,
        "roomType": "C"
    }
]