Versions Compared

Old Version 53

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.

Use these endpoints to manage dynamic playlists on the network. For constraints on headers, see REST API#Headers.

/Playlists/Dynamic/

GET

Base URL for these endpoints:  https://api.bsn.cloud/2020/10/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

[string] filter:  An 

filter string optional

An expression for filtering search results.

[string] sort: An

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

Device].[

serial

Serial] ASC")

[string] marker: A

. 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

of dynamic playlist instances exceeds the pageSize.

[int] pageSize: The maximum number of dynamic playlist instances

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

______________________________________________________________

Response

Success Response Body

Returns

200: Returns apaged listof

dynamic playlist entities

 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.

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

POST /

Create a new dynamic playlist on the network.

Required Scope Token

bsn.api.main.playlists.dynamic.create

______________________________________________________________

Request Body

TheDynamic Playlists Entity

______________________________________________________________

Response

Success Response Body

Returns a 201 status code and the new resource

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

 The response includes the Dynamic Playlists Entity.DELETE

 

Failure

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

400: Either the request or request body 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)

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

Endpoints:

Table of Contents
maxLevel2
indent20px
excludeEndpoints:



DELETE /

Removes dynamic playlists, specified by a filter, from a network. This

allows multiple

allows multiple dynamic playlists to be deleted at once.

Required Scope Token

bsn.api.main.playlists.dynamic.delete

______________________________________________________________

Query String Parameters

[string] filter:  An 

filter string required

An expression for filtering search results

.

Response Body

Returns GET

______________________________________________________________

Response

Success Response Body

204: Returns the number of affected dynamic playlists as an integer value.

Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
maxLevel3
indent20px

/Playlists/Dynamic/Count/

[string] filter:  An 

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/ 

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. 

Parameters

Required Scope Token

bsn.api.main.playlists.dynamic.retrieve

______________________________________________________________

Query String Parameter

filter string optional 

An expression for filtering search results. 

______________________________________________________________

Response

Success Response Body

The

200: The number of dynamic playlists is returned as an integer value.

/Playlists/Dynamic/Operations/

GET

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 the operational permissions granted to roles for specific business operations

Required Scope Token

bsn.api.main.operations.retrieve

______________________________________________________________

Response

Success Response Body

Returns

200: Returns the Business Operations Entity

/Playlists/Dynamic

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}/

GET

 

Returns the

dynamic playlist instance with the specified id.

Parameters

[int] id: 

specified dynamic playlist instance 

Required Scope Token

bsn.api.main.playlists.dynamic.retrieve

______________________________________________________________

Segment

id int  

A unique identifier for the dynamic playlist instance

______________________________________________________________

Response

Success Response with Body

Returns

200: Returns the Dynamic Playlists Entity

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.

Parameters

[int] id: [int] id:  

update

______________________________________________________________

Segment

id int  

A unique identifier for the dynamic playlist instance

______________________________________________________________

Request Body

TheDynamic Playlists Entity

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

DELETE

Removes the specified dynamic playlist from the network.

Parameters

[string] name: 

______________________________________________________________

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: Either the request or request body 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)

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 instance

Required Scope Token

bsn.api.main.playlists.dynamic.delete

______________________________________________________________

Segment

id int  

A unique identifier for the dynamic playlist instance

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

/Playlists/Dynamic/{name}/

GET

Returns the dynamic playlist instance with the specified name.

Parameters

______________________________________________________________

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

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

______________________________________________________________

Response

Success Response with Body

Returns

200: Returns the Dynamic Playlists Entity

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.

Parameters

[string] name: /Playlists/Dynamic

main.playlists.dynamic.update

______________________________________________________________

Segment

name string 

The name of the dynamic playlist instance

______________________________________________________________

Request Body

TheDynamic Playlists Entity

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

DELETE

Removes the specified dynamic playlist from the network.

Parameters

  • [string] name:  The name of the dynamic playlist instance

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

______________________________________________________________

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: Either the request or request body 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)

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

______________________________________________________________

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

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 /{id:int}/Permissions/ 

GET

Includes

Returns object permissions for a given dynamic playlist instance.

Parameters

[int] id:  

Required Scope Token

bsn.api.main.playlists.dynamic.retrieve

______________________________________________________________

Segment

id int 

A unique identifier for the dynamic playlist instance

______________________________________________________________

Response 

Success Response Body

Returns the Permissions Entity

POST

200: Returns an array of Permission entities 

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.

Parameters

[int] id:  DELETE

Required Scope Token

bsn.api.main.playlists.dynamic.update

______________________________________________________________

Segment

id int 

A unique identifier for the dynamic playlist instance

Request Body

The Permissions Entity

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

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

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.

Parameters

[int] id:  /Playlists/Dynamic

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

The Permissions Entity

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

______________________________________________________________

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

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/ 

GET

Includes

Returns object permissions for a given dynamic playlist instance.

Parameters

[string] name:  

Required Scope Token

bsn.api.main.playlists.dynamic.retrieve

______________________________________________________________

Segment

name string 

The name of the dynamic playlist instance

______________________________________________________________

Response

Success Response Body

Returns the Permissions Entity

POST

200: Returns an array of Permission entities 

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.

Parameters

  • [string] name:  The name the dynamic playlist instance

Request Body

The Permissions Entity

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

DELETE

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

______________________________________________________________

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

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.

Parameters

[string] name:   On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

playlists.dynamic.update

______________________________________________________________

Segment

name string 

The name of the dynamic playlist instance

______________________________________________________________

Request Body

An array of Permission entities

The Permissions Entity

Response 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

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