Playlists/Dynamic Endpoints (2022/06)

\Use these endpoints to manage dynamic playlists on the network.

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

_________________________________________________________________________

GET /

Retrieves a list of dynamic playlists on the network.

Required Scope Token

bsn.api.main.playlists.dynamic.retrieve

______________________________________________________________

Query String Parameters

filter string optional

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

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 (e.g. "[Device].[Serial] ASC"). The default value is null.

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 dynamic playlist 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 dynamic playlist 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 [Name] CONTAINS 'Building'
sort is set to [LastModifiedDate] DESC

GET /2022/06/REST/Playlists/Dynamic/?marker=MjAyMy0xMS0wMVQyMjozNzoyNC40MDNaLDExNjQwNDE3&pageSize=1&filter=%5BName%5D%20CONTAINS%20%27Building%27&sort=%5BLastModifiedDate%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 Dynamic Playlists Entity instances 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": 12345678,
      "name": "WestBuilding",
      "physicalPath": "https://bsncloud.s3.amazonaws.com/JaneDoe/87a992afd6071576647ecd1fd65776ba",
      "fileSize": 1060,
      "fileHash": "SHA1:B995E0604EDD01F5E143B0329AABE9A14D06B821",
      "creationDate": "2023-11-01T22:36:42.153Z",
      "lastModifiedDate": "2023-11-01T22:36:42.253Z",
      "supportsAudio": true,
      "supportsVideo": true,
      "supportsImages": true,
      "content": null,
      "presentations": [      {
         "id": 3210,
         "name": "Test4Buildings",
         "type": "Presentation",
         "link": null
      }],
      "permissions": []
   }],
   "totalItemCount": 3,
   "matchingItemCount": 2,
   "pageSize": 1,
   "nextMarker": "MjAyMy0xMS0wMVQyMjozNjo0Mi4yNTNaLDExNjQwNDE1",
   "isTruncated": false,
   "sortExpression": "[LastModifiedDate] DESC",
   "filterExpression": "[Name] CONTAINS 'Building'"
}

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

Endpoints:

1 GET /
2 POST /
3 DELETE /
4 GET /Count/
5 GET /{id:int}/
6 PUT /{id:int}/
7 DELETE /{id:int}/
8 GET /{name}/
9 PUT /{name}/
10 DELETE /{name}/
11 GET /Operations/
12 GET /{id:int}/Permissions/
13 POST /{id:int}/Permissions/
14 DELETE /{id:int}/Permissions/
15 GET /{name}/Permissions/
16 POST /{name}/Permissions/
17 DELETE /{name}/Permissions/

POST /

Create a new dynamic playlist on the network.

Required Scope Token

bsn.api.main.playlists.dynamic.create

______________________________________________________________

Request Body

The Dynamic Playlists Entity

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

POST /2022/06/REST/Playlists/Dynamic/ 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
Content-Type: application/json
Content-Length: 328

This is the example request body:

______________________________________________________________

Response

Success Response Body

201: Returns the Dynamic Playlists Entity created and referenced by the Uri (given by the Location header field) in the response

Example

Failure

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

400: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules

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)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

DELETE /

Removes dynamic playlists, specified by a filter, from a network. This allows multiple dynamic playlists to be deleted at once.

Required Scope Token

bsn.api.main.playlists.dynamic.delete

______________________________________________________________

Query String Parameter

filter string required

An expression for filtering search results

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

filter is set to [Name] CONTAINS 'Southeast'

______________________________________________________________

Response

Success Response Body

200: Returns the number of affected dynamic playlists 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 or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules (for example, the specified dynamic playlist is being used in a presentation and cannot be deleted)

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/

Returns the number of dynamic playlists on the network that match the specified filter criteria. If no filter is included, this call returns the total number of dynamic playlists on the network.

Required Scope Token

bsn.api.main.playlists.dynamic.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 [SupportsVideo] IS TRUE

______________________________________________________________

Response

Success Response Body

200: The number of dynamic playlists 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 /{id:int}/

Returns the specified dynamic playlist instance

Required Scope Token

bsn.api.main.playlists.dynamic.retrieve

______________________________________________________________

Segment

id int

A unique identifier for the dynamic playlist instance

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

id is set to 12345678

______________________________________________________________

Response

Success Response with Body

200: Returns the Dynamic Playlists Entity

Example

This is an example of a 200 level response:

Success Response

304: The resource was not modified since the time specified in the “If-Modified-Since” header

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

404: The server cannot find the requested resource (the path does not exist)

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

PUT /{id:int}/

Modifies the specified dynamic playlist instance

Required Scope Token

bsn.api.main.playlists.dynamic.update

______________________________________________________________

Segment

id int

A unique identifier for the dynamic playlist instance

______________________________________________________________

Request Body

The Dynamic Playlists Entity

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

id is set to 01234567

This is the example request body:

______________________________________________________________

Response

Success

204: The specified dynamic playlist has been modified

Failure

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

400: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules

401: The access token is invalid or not specified

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

404: The server cannot find the requested resource (the path does not exist)

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

412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

DELETE /{id:int}/

Removes the specified dynamic playlist

Required Scope Token

bsn.api.main.playlists.dynamic.delete

______________________________________________________________

Segment

id int

A unique identifier for the dynamic playlist instance

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

id is set to 01234567

______________________________________________________________

Response

Success

204: The specified dynamic playlist file has been removed from the network

Failure

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

400: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules

401: The access token is invalid or not specified

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

404: The server cannot find the requested resource (the path does not exist)

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

412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)

5XX: Any 500 code is an internal server error

GET /{name}/

Returns the specified dynamic playlist instance

Required Scope Token

bsn.api.main.playlists.dynamic.retrieve

______________________________________________________________

Segment

name string

The name of the dynamic playlist instance

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

name is set to WestBuilding

______________________________________________________________

Response

Success Response with Body

200: Returns the Dynamic Playlists Entity

Example

This is an example of a 200 level response:

Success Response

304: The resource was not modified since the time specified in the “If-Modified-Since” header

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

404: The server cannot find the requested resource (the path does not exist)

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

PUT /{name}/

Modifies the specified dynamic playlist instance

Required Scope Token

bsn.api.main.playlists.dynamic.update

______________________________________________________________

Segment

name string

The name of the dynamic playlist instance

______________________________________________________________

Request Body

The Dynamic Playlists Entity

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

name is set to Southwest

This is the example request body:

______________________________________________________________

Response

Success

204: The specified dynamic playlist has been modified

Failure

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

400: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules

401: The access token is invalid or not specified

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

404: The server cannot find the requested resource (the path does not exist)

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

412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

DELETE /{name}/

Removes the specified dynamic playlist

Required Scope Token

bsn.api.main.playlists.dynamic.delete

______________________________________________________________

Segment

name string

The name of the dynamic playlist instance

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

name is set to Northeast

______________________________________________________________

Response

Success

204: The specified dynamic playlist file has been removed from the network

Failure

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

400: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules

401: The access token is invalid or not specified

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

404: The server cannot find the requested resource (the path does not exist)

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

412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)

5XX: Any 500 code is an internal server error

GET /Operations/

Returns the 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

GET /{id:int}/Permissions/

Includes object permissions for a given dynamic playlist instance

Required Scope Token

bsn.api.main.playlists.dynamic.retrieve

______________________________________________________________

Segment

id int

A unique identifier for the dynamic playlist instance

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

id is 12345678

______________________________________________________________

Response

Success Response Body

200: Returns an array of Permission entities

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

404: The server cannot find the requested resource (the path does not exist)

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

POST /{id:int}/Permissions/

Adds permissions to the specified dynamic playlist instance.

Required Scope Token

bsn.api.main.playlists.dynamic.update

______________________________________________________________

Segment

id int

A unique identifier for the dynamic playlist instance

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

id is set to 987654321

This is the example request body:

______________________________________________________________

Response

Success

204: The permissions were successfully added to the specified dynamic playlist

Failure

400: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules

401: The access token is invalid or not specified

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

404: The server cannot find the requested resource (the path does not exist)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

DELETE /{id:int}/Permissions/

Removes permissions for the specified dynamic playlist.

Required Scope Token

bsn.api.main.playlists.dynamic.update

______________________________________________________________

Segment

id int

A unique identifier for the dynamic playlist instance

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

id is 12345678

This is the example request body:

______________________________________________________________

Response

Success

204: The specified permissions were successfully deleted

Failure

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

400: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules

401: The access token is invalid or not specified

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

404: The server cannot find the requested resource (the path does not exist)

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 /{name}/Permissions/

Includes object permissions for a given dynamic playlist instance.

Required Scope Token

bsn.api.main.playlists.dynamic.retrieve

______________________________________________________________

Segment

name string

The name of the dynamic playlist instance

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

name is NorthBuilding

______________________________________________________________

Response

Success Response Body

200: Returns an array of Permission entities

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

404: The server cannot find the requested resource (the path does not exist)

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

POST /{name}/Permissions/

Adds permissions to the specified dynamic playlist instance.

Required Scope Token

bsn.api.main.playlists.dynamic.update

______________________________________________________________

Segment

name string

The name of the dynamic playlist instance

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

id is set to NorthBuilding

This is the example request body:

______________________________________________________________

Response

Success

204: The permissions were successfully added to the specified dynamic playlist

Failure

400: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules

401: The access token is invalid or not specified

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

404: The server cannot find the requested resource (the path does not exist)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

DELETE /{name}/Permissions/

Removes permissions for the specified dynamic playlist.

Required Scope Token

bsn.api.main.playlists.dynamic.update

______________________________________________________________

Segment

name string

The name of the dynamic playlist instance

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

id is NorthBuilding

This is the example request body:

______________________________________________________________

Response

Success

204: The specified permissions were successfully deleted

Failure

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

400: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules

401: The access token is invalid or not specified

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

404: The server cannot find the requested resource (the path does not exist)

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