Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
maxLevel3
indent20px

/subscriptions/

GET

...

Parameters

  • pageIndex:
  • marker:
  • pageSize:
  • filter:  
  • sort:

Request Body

 

Response Body

POST

...

Parameters

 

Request Body

 

Response Body

 

PATCH

...

Parameters

  •  filter

Request Body

 

Response Body

 

DELETE

...

Parameters

  •  filter

Request Body

 

Response Body

 

/subscriptions/count/

GET

...

Parameters

  • filter:  

Request Body

 

Response Body

 

/subscriptions/operations/

GET

...

Parameters

 

Request Body

 

Response Body

 

/subscriptions/{subscription_id}/

GET

...

Parameters

 

Request Body

 

Response Body

 

POST

...

Parameters

 

Request Body

 

Response Body

 

PATCH

...

Parameters

 

Request Body

 

Response Body

...

These endpoints allow users to manage device subscriptions on a network. 

Base URL for these endpoints:  https://api.brightsignnetwork.com/2017/01/REST/Subscriptions

GET  /

Returns a list of subscriptions

Parameters

marker  string

A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of presentations exceeds the pageSize.

pageSize  int

The maximum number of presentations that can be contained in the response body

______________________________________________________________

Response Body

Returns a paged list of Device Subscription Entity instances on a network. This will return not more than 100 entities along with the information necessary to return any other remaining pages.

POST  /

Activates subscription keys on a network

Request Body

key  string

The name of the subscription key (a token, that when activated, associates the key with subscriptions)

______________________________________________________________

Response Body

Complete information about the subscriptions which have been successfully added to a network as the result of activation.

GET  /Operations/ 

Returns the operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity

Endpoints:

Table of Contents
maxLevel2
indent20px
excludeEndpoints: