A room at your convention venue.
You must have the scheduling or exhibitors ConventionPrivilege to access this.
Rooms are accessed via /api/room.
See "Object Properties" in Introduction for basic shared properties.
Complete details in RoomProperties.
See "Related Objects" in Introduction for how to use them.
The Convention this room belongs to.
The ConventionImage that represents a map of this room.
See "Relationships" in Introduction for how to use them.
The list of Booths in this room.
The list of Events taking place in this room.
The list of EventSessions taking place in this room.
The list of EventTypeRooms for this room. These associate a room with an event type, they are not the associated Event Types themselves.
The list of EventTypes allowed for this room.
The list of RoomZones for this room.
The list of volunteer ShiftTypes associated with this room.
The list of scheduling time Slots associated with this room.
The list of Spaces in this room.
See "Includes" in Introduction for how to use them.
Includes the counts of child Booths, Spaces, and RoomZones. Field is returned in format:
{
"id" : "xxx",
"name" : "Chippewa Ballroom",
...
"child_counts" : {
"booths_count" : [integer],
"spaces_count" : [integer],
"roomzones_count" : [integer],
},
...
}
The services used to fetch and manipulate rooms.
This will search across all conventions. To search on a single convention see "Relationships" in Convention.
GET /api/room
Searches a partial name.
Returns:
{
"paging" : {...},
"items" : [
{
"id" : "xxx",
"name" : "Chippewa Ballroom",
...
},
...
]
}
POST /api/room
Returns the same as a normal read.
GET /api/room/xxx
Returns:
{
"id" : "xxx",
"name" : "Chippewa Ballroom",
...
}
PUT /api/room/xxx
Returns the same as a normal read.
DELETE /api/room/xxx
Returns:
{
"success" : 1
}
Returns the information you would need to schedule an event in a room at a specific day part.
GET /api/room/xxx/slot-grid
Defaults to 120.
Returns a list of dayparts and a grid of slots:
{
"dayparts" : [
{
"id" : "xxx",
"name" : "Friday",
...
},
...
],
"grid" : [
[
{
"id" : "xxx",
"name" : "Table E3 in Chippewa Ballroom on Friday at 10am",
"space" : {
"id" : "xxx",
"name" : "Table E3",
...
},
"event" : {
"id" : "xxx",
"name" : "The Captain is Dead",
...
},
...
},
...
],
...
],
}
Clears any Discord information for the Room and its Spaces.
POST /api/room/xxx/discord/clear
Returns the same as a normal read.
Refreshes the list of available DayParts the room has for EventSubmissions.
POST /api/room/xxx/available-dayparts/refresh
Returns:
{
"success" : 1
}