Versions Compared

Old Version 40

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version Current

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Base URL for these endpoints:  https://api.bsn.cloud/2020/10/REST/Subscriptions/

_________________________________________________________________________

GET /

Returns a list of device subscriptions

Required Scope Token

bsn.api.main.subscriptions.retrieve

______________________________________________________________

Query String Parameters

marker string optional

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 device subscription instances exceeds the pageSize.

This parameter is

only 

only required

 if 

 if you need more elements in the paged list than

the 

the pageSize (100).

pageSize 

int 

int optional

The maximum number of device subscription instances that can be contained in the response body. This defaults to the maximum allowed page size (100).

______________________________________________________________

Response

Success Response Body

200:

 Returns

 Returns apaged listof Player Subscription entities on a network. This will return not more than 100 entities along with the information necessary to return any other remaining pages.

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

he

400:

 T

 The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406:

 The specified representation of the device subscription entity is not acceptable

 The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Endpoints:

Table of Contents
maxLevel2
indent20px
excludeEndpoints:



GET /Count/

GET

 

Retrieves the number of subscription instances on the network matching the specified filter criteria. If no filter is included, this call returns the total number of subscription instances on the network. 

Required Scope Token

bsn.api.main.subscriptions.retrieve

______________________________________________________________

Query String Parameter

filter

 

string

An expression for filtering search results.

 The

 The default value is null.

______________________________________________________________

Response 

Success Response Body

Success

200:

 The

 The subscription instance count is returned as an integer value

.

Failure

300: The

device subscription files are not specified correctly (there is more than one possible response

requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400:

 Either the request or the device subscription entity is invalid or not specified

 The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406:

 The specified representation of the device subscription entity is not acceptable

 The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

GET /Operations/

GET

 

Returns operational permissions granted to roles for specific business operations

Required Scope Token

bsn.api.main.operations

Response Body

Success

200: Returns

.retrieve

______________________________________________________________

Response

Success Response Body

200: Returns the Business Operations Entity

Failure

300: The

business operations tree is not specified correctly (there is more than one possible response

requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400:

 Either the request or the business operations tree is invalid or not specified

 The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406: The

specified business operations tree is not acceptable

server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error