BrightSignNetwork (BSN) Main A...
Main REST HTTP API version 201...
Playlists/Tagged Endpoints (2017/01)
12min
use these endpoints to manage tagged playlists on the network base url for these endpoints https //api brightsignnetwork com/2017/01/rest/playlists/tagged get / returns a list of tagged playlists on the network parameters filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results 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 ") 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 tagged playlist instances exceeds the pagesize pagesize int the maximum number of tagged playlist instances that can be contained in the response body response body returns a paged list entity (2017/01) docid\ yn3gu asyfisjdxgbjdvb of tagged playlist entity (2017/01) docid 8nnv93lc5j0vloxsjho c instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages post / creates a tagged playlist on the network request body the tagged playlist entity (2017/01) docid 8nnv93lc5j0vloxsjho c 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 tagged playlist entity (2017/01) docid 8nnv93lc5j0vloxsjho c delete / removes tagged playlists, specified by a filter, from the network this allows you to delete multiple tagged playlists at once parameters filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results response body returns the number of affected tagged playlists as an integer value 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 parameters filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results response body the number of tagged playlists is returned as an integer value get /{id\ int}/ returns the tagged playlist instance with the specified id parameters id int a unique identifier for the tagged playlist instance response body returns the tagged playlist entity (2017/01) docid 8nnv93lc5j0vloxsjho c put /{id\ int}/ modifies the specified tagged playlist instance parameters id int a unique identifier for the tagged playlist instance request body the tagged playlist entity (2017/01) docid 8nnv93lc5j0vloxsjho c response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{id\ int}/ removes the specified tagged playlist from the network parameters id int a unique identifier for the tagged playlist instance response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /{name}/ returns the tagged playlist instance with the specified name parameters name string the name of the tagged playlist instance response body returns the tagged playlist entity (2017/01) docid 8nnv93lc5j0vloxsjho c put /{name}/ modifies the specified tagged playlist instance parameters name string the name of the tagged playlist instance request body the tagged playlist entity (2017/01) docid 8nnv93lc5j0vloxsjho c response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{name}/ removes the tagged playlist from the network parameters name string the name of the tagged playlist instance response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /operations/ returns the operational permissions granted to roles for specific business operations response body returns the business operations entity (2017/01) docid\ fwdujpp aohpf3res sz get /{id\ int}/permissions/ includes object permissions for a given tagged playlist instance parameters id int a unique identifier for the tagged playlist instance response body returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{id\ int}/permissions/ retrieves the permissions for the specified tagged playlist on the network parameters id int a unique identifier for the tagged playlist instance request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{id\ int}/permissions/ removes permissions for the specified tagged playlist parameters id int a unique identifier for the tagged playlist instance request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /{name}/permissions/ includes object permissions for a given tagged playlist instance parameters name string the name of the tagged playlist instance request body returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{name}/permissions/ retrieves the permissions for the specified tagged playlist on the network parameters name string the name of the tagged playlist instance request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{name}/permissions/ removes permissions for the specified tagged playlist parameters name string the name of the tagged playlist instance request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx