Hub 2019.1 Help

Get All Viewers of a Service

Request

GET <REST API URL>/services/{service id}/viewers?fields=string&$skip=int&$top=int

Parameter

Description

fields

Optional. Returns only the specified subset of the fields for each Viewer. Use Fields Syntax to define the subset.

$skip

Optional. Lets you set a number of Viewers to skip before returning the first one.

$top

Optional. Lets you set the maximum number of Viewers to return.

Response

Response Code

Meaning

200 OK

Successful request.

400 Bad Request

At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.

403 Forbidden

The requester has no access to the requested resource.

404 Not Found

The requested resource was not found.

500 Internal Server Error

Failed to process request because of the server error. For details, check the error message in the response.

Response body

{ "skip": int, "top": int, "total": int, "viewers": [authorityHolder, ...] }
Last modified: 17 February 2020