ROOMS

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

The actions here allow you to Add, Update, Fetch, and Delete the Rooms in the system.

You can also fetch Events based on a given Rooms.


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.

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


GET /room/{id}

Get a Room by Id.

Response:

200 OK and JSON containing the Room object.

or

204 No Content if no Room exists.


GET /room/reference/{referenceId}

Get a Room by Reference Id.

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:

PageSize:   {int} - Number of results to consider in a page.

PageNumber: {int} - Number of the page you are requesting.

Order: {QueryOrder} - Optional. ASC or DESC.

Response: 200 OK and JSON containing an Event collection.


DEL /room/{id}

Delete a Room by Id.

Response: 410 Gone