Getting guest entitlements room status

Request

To get details about the user’s guest entitlements room (how many devices are using it, the start and end time, and so on) so it can display them to the user, the client app should send a GET request to:

https://<host>:<port>/ges/v1/user/room/{roomId}

Headers

• Authorisation

• x-correlation-id – identifier for logging, to correlate messages across a call flow

Mandatory arguments

• roomId – the ID of the room (in the URL)

Response

A successful request returns an HTTP 200 status.

Example

A successful request returns a payload that looks like this:

{
  "startTime": 1710490050,
  "endTime": 1710504450,
  "roomId": "YE7JY49WGU",
  "guestList": [
    {
      "deviceName": "Living Room STB"
    }
  ],
  "countBase": "DEVICE"
}

Here:

• Start and end time are in Unix epoch time

• countBase shows whether the guest count is based on number of devices or number of accounts.

See also

• Guest Entitlements Service (GES) API documentation