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 string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results the default value is null sort string string optional 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 string optional 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 int optional 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 200 returns a paged list entity (2020/10) docid\ joielmbbiwrnzeqzvpqqa of tagged playlists entity (2020/10) docid\ he2rdsl axwtnsrmyygez 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 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 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 the tagged playlists entity (2020/10) docid\ he2rdsl axwtnsrmyygez response success response body 201 201 returns the tagged playlists entity (2020/10) docid\ he2rdsl axwtnsrmyygez created and referenced by the uri (given by the location header field) in the response failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 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 string required required an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results response success response body 200 200 returns the number of affected tagged playlists as an integer value failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 400 400 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error 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 string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results response success response body 200 200 the number of tagged playlists is returned as an integer value failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 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 int a unique identifier for the tagged playlist instance response success response with body 200 200 returns the tagged playlists entity (2020/10) docid\ he2rdsl axwtnsrmyygez success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 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 int a unique identifier for the tagged playlist instance request body the tagged playlists entity (2020/10) docid\ he2rdsl axwtnsrmyygez response success 204 204 the specified tagged playlist has been updated on the network failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 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 int a unique identifier for the tagged playlist instance response success 204 204 the specified tagged playlist file has been removed failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 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 string the name of the tagged playlist instance response success response with body 200 200 returns the tagged playlists entity (2020/10) docid\ he2rdsl axwtnsrmyygez success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 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 string the name of the tagged playlist instance request body the tagged playlists entity (2020/10) docid\ he2rdsl axwtnsrmyygez response success 204 204 the specified tagged playlist has been updated on the network failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 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 string the name of the tagged playlist instance response success 204 204 the specified tagged playlist file has been removed failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 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 200 returns the business operations entity (2020/10) docid\ ychro4ocgshfhae1gvygf failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 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 int a unique identifier for the tagged playlist instance response success response body 200 200 returns an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 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 int a unique identifier for the tagged playlist instance request body permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the permissions were successfully added to the specified tagged playlist failure 400 400 the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 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 int a unique identifier for the tagged playlist instance request body an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the specified permissions were successfully deleted failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 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 string the name of the tagged playlist instance response success response body 200 200 returns an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 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 string the name of the tagged playlist instance request body permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the permissions were successfully added to the specified tagged playlist failure 400 400 the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 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 string the name of the tagged playlist instance request body an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the specified permissions were successfully deleted failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error