Device Subscriptions Endpoints (2022/06)

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

Base URL for these endpoints: https://api.bsn.cloud/2022/06/REST/Subscriptions

_________________________________________________________________________

Endpoints:

1 GET /
2 GET /Count/
3 GET /Operations/

GET /

Returns a list of device subscriptions

Required Scope Token

bsn.api.main.subscriptions.retrieve

______________________________________________________________

Query String Parameters

filter string optional

A search expression for narrowing the result set

sort string optional

An expression for sorting the search results. The sort expression specifies the entry used for sorting and the ascending/descending (ASC/DESC) sorting order (see this page for more information).

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 required if you need more elements in the paged list than the pageSize (100).

pageSize 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).

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

marker value is set to the [PagedList].[NextMarker] property value from the previous BSN.cloud API response.
pageSize is set to 1
filter is set to [Device] IS NULL AND [Status] IS IN ('Active', 'Suspending')
sort is set to [CreationDate] DESC

GET /2022/06/REST/Subscriptions/?marker=NDI0NTY0LDQyNDU2NA%3D%3D&pageSize=1&filter=%5BDevice%5D%20IS%20NULL%20AND%20%5BStatus%5D%20IS%20IN%20%28%27Active%27%2C%20%27Suspending%27%29&sort=%5BCreationDate%5D%20DESC HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Response

Success Response Body

200: Returns a paged list of 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.

Example

{
   "items": [   {
      "id": 424574,
      "device": null,
      "type": "Commercial",
      "activityPeriod": "365.00:00:00",
      "status": "Active",
      "creationDate": "2023-06-02T07:02:52.99Z",
      "lastModifiedDate": "2023-06-02T07:02:52.99Z",
      "activationDate": "2023-06-02T07:02:52.99Z",
      "suspensionDate": null,
      "expirationDate": null
   }],
   "totalItemCount": 20,
   "matchingItemCount": 9,
   "pageSize": 1,
   "nextMarker": "MjAyMy0wNi0wMlQwNzowMjo1Mi45OTBaLDQyNDU3NA==",
   "isTruncated": true,
   "sortExpression": "[CreationDate] DESC",
   "filterExpression": "[Device] IS NULL AND [Status] IS IN ( 'Active' , 'Suspending' )"
}

Failure

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

400: 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 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 /Count/

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 optional

An expression for filtering search results. The default value is null.

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

filter is set to[Id] IS GREATER THAN 0 AND [Status] IS IN ('Active', 'Suspending')

GET /2022/06/REST/Subscriptions/Count/?pageSize=0&filter=%5BId%5D%20IS%20GREATER%20THAN%200%20AND%20%5BStatus%5D%20IS%20IN%20%28%27Active%27%2C%20%27Suspending%27%29 HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Response

Success Response Body

200: The subscription instance count is returned as an integer value.

Failure

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

400: 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 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/

Returns operational permissions granted to roles for specific business operations

Required Scope Token

bsn.api.main.operations.retrieve

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

______________________________________________________________

Response

Success Response Body

200: Returns the Business Operations Entity

Example

Failure

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

400: 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 server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error