Room

NOTE HERE ABOUT WHAT THIS IS FOR. You must have the scheduling or exhibitors ConventionPrivilege to access this. Rooms are accessed via /api/room.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in RoomProperties.

Related Objects

See "Related Objects" in Introduction for how to use them.

convention

The Convention this room belongs to.

mapimage

The ConventionImage that represents a map of this room.

Relationships

See "Relationships" in Introduction for how to use them.

booths

Queryable
name
Qualifiers
exhibitor_id
roomzone_id
exhibitor.status

events

Queryable
name

eventtyperooms

eventtypes

roomzones

slots

spaces

Services

The services used to fetch and manipulate rooms.

Search Rooms

This will search across all conventions. To search on a single convention see "Relationships" in Convention.

 GET /api/room
Optional Params
query

Searches a partial name.

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "name" : "Chippewa Ballroom",
          ...
        },
        ...
    ]
 }

Create Room

 POST /api/room
Required Params
convention_id
name

Returns the same as a normal read.

Read Room

 GET /api/room/xxx

Returns:

 {
   "id" : "xxx",
   "name" : "Chippewa Ballroom",
   ...
 }

Update Room

 PUT /api/room/xxx

Returns the same as a normal read.

Delete Room

 DELETE /api/room/xxx

Returns:

 {
   "success" : 1
 }

Get Slot Grid

Returns the information you would need to schedule an event in a room at a specific day part.

 GET /api/room/xxx/slot-grid
Required Params
daypart_id
Optional Params
duration

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",
                    ...
                },
                ...
            },
            ...
        ],
        ...
    ],
 }