Rooms

• Room Object
• Supported Actions
  • POST /room/
  • PUT /room/{id}
  • GET /room/
  • GET /room/{id}
  • GET /room/reference
  • GET /room/{id}/events/
  • DEL /room/{id}

---

Rooms are a type of metadata available in the system, and are set on a per-Event basis.

---

Room Object

{
  "Id": "ef6cafaa-36ca-2732-8c16-bec63ece59de",
  "Name": "Example Room",
  "ReferenceId": "reference-Id"
}

---

Supported Actions

POST /room/

Add a new Room.

Request Body:

{
  "name": "Example Room",
  "referenceId": "reference-Id"
}

Response: 201 Created

---

PUT /room/{id}

Update a Room by Id.

Request Body:

{
  "name": "Example Room (Renamed)",
  "referenceId": "reference-Id"
}

Response: 200 OK

---

GET /room/

Get all Rooms.

Query Parameters:

Name	Type	Required	Description
noCache	bool	No	Whether or not to bypass cache. Defaults to False.

Response: 200 OK and a JSON array containing multiple Room objects.

---

GET /room/{id}

Get a Room by Id.

Query Parameters:

Name	Type	Required	Description
noCache	bool	No	Whether or not to bypass cache. Defaults to False.

Response:

200 OK and JSON containing the Room object.

or

204 No Content if no Room exists.

---

GET /room/reference

Get a Room by Reference Id.

Query Parameters:

Name	Type	Required	Description
id	string	Yes	The reference ID. Must be percent-encoded.
noCache	bool	No	Whether or not to bypass cache. Defaults to False.

Response:

200 OK and JSON containing the Room object.

or

204 No Content if no Room exists.

---

GET /room/{id}/events/

Get Events which have the given Room Id set.

Query Parameters:

Query Parameters:

Name	Type	Required	Description
pageSize	int	No	Number of results to fetch per Page.
pageNumber	int	No	Number of the page to fetch.
order	QueryOrder	No	The order to sort by, either ASC or DESC. Defaults to ASC.
noCache	bool	No	Whether or not to bypass cache. Defaults to False.

Response: 200 OK and JSON containing an Event collection.

---

DEL /room/{id}

Delete a Room by Id.

Response: 410 Gone