Use these endpoints to manage dynamic playlists on the network.
Base URL for these endpoints: https://api.bsn.cloud/2020/10/REST/Playlists/Dynamic/
_________________________________________________________________________
GET
Retrieves a list of dynamic playlists on the network.
Parameters
filter string
An expression for filtering search results. The default value is null.
sort string
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
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.
pageSize int
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 Body
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.
POST
Create a new dynamic playlist on the network.
Request Body
______________________________________________________________
Response Body
Returns a 201 status code and the new resource created and referenced by the Uri (given by the Location header field) in the response. The response includes the Dynamic Playlists Entity.
DELETE
Removes dynamic playlists, specified by a filter, from a network. This allows multiple dynamic playlists to be deleted at once.
Parameters
filter string
An expression for filtering search results
______________________________________________________________
Response Body
Returns the number of affected dynamic playlists as an integer value.
Endpoints:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Count/GET
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
filter string
An expression for filtering search results.
______________________________________________________________
Response Body
The number of dynamic playlists is returned as an integer value.
Operations/GET
Returns the operational permissions granted to roles for specific business operations
Response Body
Returns the Business Operations Entity
{id:int}/GET
Returns the dynamic playlist instance with the specified id.
Parameters
id int
A unique identifier for the dynamic playlist instance
______________________________________________________________
Response Body
Returns the Dynamic Playlists Entity
{id:int}/PUT
Modifies the specified dynamic playlist instance.
Parameters
id int
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 Parameters
filter string required
An expression for filtering search results
______________________________________________________________
Response
Success Response Body
204: 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 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.
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
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 /Operations/
Returns the operational permissions granted to roles for specific business operations
Required Scope Token
bsn.api.main.operations.retrieve
______________________________________________________________
Response
Success Response Body
200: Returns the Business Operations Entity
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
______________________________________________________________
Response
Success Response with Body
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.update
______________________________________________________________
Segment
id int
A unique identifier for the dynamic playlist instance
______________________________________________________________
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: 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
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
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.main.playlists.dynamic.update
______________________________________________________________
Segment
name string
The name of the dynamic playlist instance
______________________________________________________________
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: 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/
Returns 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
______________________________________________________________
Response
Success Response Body
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.
Required Scope Token
bsn.api.main.playlists.dynamic.update
______________________________________________________________
Request Body
________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.
{id:int}/DELETE
Removes the specified dynamic playlist from the network.
Parameters
id int
A unique identifier for the dynamic playlist instance
________
Request Body
An array of Permission entities
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
{name}/GET
Returns the dynamic playlist instance with the specified name.
Parameters
name string
The name of the dynamic playlist instance
_____________________________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.
Required Scope Token
bsn.api.main.playlists.dynamic.update
______________________
Response Body
Returns the Dynamic Playlists Entity
{name}/PUT
Modifies the specified dynamic playlist instance.
Parameters
name string
The name of the dynamic playlist instance
________________________________________
Segment
id int
A unique identifier for the dynamic playlist instance
______________________
Request Body
________________________________________
Request Body
An array of Permission entities
___________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
{name}/DELETE
Removes the specified dynamic playlist from the network.
Parameters
name string
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.
{id:int}/Permissions/GET
Includes A unique identifier for the dynamic playlist instanceResponse
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/
Returns object permissions for a given dynamic playlist instance.
Parameters
id int
Required Scope Token
bsn.api.main.playlists.dynamic.retrieve
____________________________________________________________
Response Body
Returns the Permission Entity
{id:int}/Permissions/POST
Adds permissions to the specified dynamic playlist instance.
Parameters
id int
__
Segment
name string
The name of the dynamic playlist instance
_____________________________________________________________
Request Body
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
{id:int}/Permissions/DELETE
Removes permissions for the specified dynamic playlist.
Parameters
id int
_
Response
Success Response Body
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.
Required Scope Token
bsn.api.main.playlists.dynamic.update
______________________________________________________________
Request Body
Segment
name string
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.
{name}/Permissions/GET
Includes object permissions for a given dynamic playlist instance.
Parameters
name string
The name of the dynamic playlist instance
Request Body
An array of Permission entities
______________________________________________________________
Response Body
Returns the Permission Entity
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/
Adds permissions to the specified dynamic playlist instance.
Parameters
name string
Removes permissions for the specified dynamic playlist.
Required Scope Token
bsn.api.main.playlists.dynamic.update
______________________________________________________________
Request Body
The Permission EntitySegment
name string
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.
{name}/Permissions/DELETE
Removes permissions for the specified dynamic playlist.
Parameters
name string
Request Body
An array of Permission entities
_____________________________________________________________
Request Body
______________________________________________________________
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