Playlists/Tagged Endpoints (2020/10)
Use these endpoints to manage tagged playlists on the network.
Base URL for these endpoints: https://api.bsn.cloud/2020/10/REST/Playlists/Tagged
_________________________________________________________________________
GET /
Returns a list of tagged playlists on the network.
Required Scope Token
bsn.api.main.playlists.tagged.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 tagged 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 tagged playlist instances that can be contained in the response body. This defaults to the maximum allowed page size (100).
______________________________________________________________
Response
Success Response Body
200: Returns a paged list of Tagged 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 /
Creates a tagged playlist on the network.
Required Scope Token
bsn.api.main.playlists.tagged.create
______________________________________________________________
Request Body
______________________________________________________________
Response
Success Response Body
201: Returns the Tagged Playlists Entity created and referenced by the Uri (given by the Location header field) in the response.
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
DELETE /
Removes tagged playlists, specified by a filter, from the network. This allows you to delete multiple tagged playlists at once.
Required Scope Token
bsn.api.main.playlists.tagged.delete
______________________________________________________________
Query String Parameter
filter string required
An expression for filtering search results
______________________________________________________________
Response
Success Response Body
200: Returns the number of affected tagged 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
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/
GET /Count/
Returns the number of tagged playlists on the network that match the specified filter criteria. If no filter is included, this call returns the total number of tagged playlists on the network.
Required Scope Token
bsn.api.main.playlists.tagged.retrieve
______________________________________________________________
Query String Parameter
filter string optional
An expression for filtering search results
______________________________________________________________
Response
Success Response Body
200: The number of tagged 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 tagged playlist instance
Required Scope Token
bsn.api.main.playlists.tagged.retrieve
______________________________________________________________
Segment
id int
A unique identifier for the tagged playlist instance
______________________________________________________________
Response
Success Response with Body
200: Returns the Tagged 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 tagged playlist instance
Required Scope Token
bsn.api.main.playlists.tagged.update
______________________________________________________________
Segment
id int
A unique identifier for the tagged playlist instance
______________________________________________________________
Request Body
______________________________________________________________
Response
Success
204: The specified tagged playlist has been updated on the network
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 tagged playlist
Required Scope Token
bsn.api.main.playlists.tagged.delete
______________________________________________________________
Segment
id int
A unique identifier for the tagged playlist instance
______________________________________________________________
Response
Success
204: The specified tagged playlist file has been removed
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 tagged playlist instance
Required Scope Token
bsn.api.main.playlists.tagged.retrieve
______________________________________________________________
Segment
name string
The name of the tagged playlist instance
______________________________________________________________
Response
Success Response with Body
200: Returns the Tagged 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 tagged playlist instance
Required Scope Token
bsn.api.main.playlists.tagged.create
______________________________________________________________
Segment
name string
The name of the tagged playlist instance
______________________________________________________________
Request Body
______________________________________________________________
Response
Success
204: The specified tagged playlist has been updated on the network
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 tagged playlist
Required Scope Token
bsn.api.main.playlists.tagged.delete
______________________________________________________________
Segment
name string
The name of the tagged playlist instance
______________________________________________________________
Response
Success
204: The specified tagged playlist file has been removed
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 /Operations/
Returns the operational permissions granted to roles for specific business operations
Required Scope Token
bsn.api.main.playlists.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}/Permissions/
Returns object permissions for a given tagged playlist instance
Required Scope Token
bsn.api.main.playlists.tagged.retrieve
______________________________________________________________
Segment
id int
A unique identifier for the tagged 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/
Retrieves the permissions for the specified tagged playlist on the network.
Required Scope Token
bsn.api.main.playlists.tagged.update
______________________________________________________________
Segment
id int
A unique identifier for the tagged playlist instance
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The permissions were successfully added to the specified tagged 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 tagged playlist.
Required Scope Token
bsn.api.main.playlists.tagged.delete
______________________________________________________________
Segment
id int
A unique identifier for the tagged playlist instance
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
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/
Returns object permissions for a given tagged playlist instance.
Required Scope Token
bsn.api.main.playlists.tagged.retrieve
______________________________________________________________
Segment
name string
The name of the tagged 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 /{name}/Permissions/
Retrieves the permissions for the specified tagged playlist on the network.
Required Scope Token
bsn.api.main.playlists.tagged.update
______________________________________________________________
Segment
name string
The name of the tagged playlist instance
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The permissions were successfully added to the specified tagged 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 tagged playlist.
Required Scope Token
bsn.api.main.playlists.tagged.update
______________________________________________________________
Segment
name string
The name of the tagged playlist instance
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
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