BrightSignNetwork (BSN) Main A...
Main REST HTTP API version 201...
Playlists/Dynamic Endpoints (2017/01)
12min
use these endpoints to manage dynamic playlists on the network base url for these endpoints https //api brightsignnetwork com/2017/01/rest/playlists/dynamic get / retrieves a list of dynamic 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 dynamic playlist instances exceeds the pagesize pagesize int the maximum number of dynamic playlist instances that can be contained in the response body response body returns a paged list entity (2017/01) docid\ yn3gu asyfisjdxgbjdvb of dynamic playlists entity (2017/01) docid\ cc1mr0qles6tsrkh4ah0g 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 the dynamic playlists entity (2017/01) docid\ cc1mr0qles6tsrkh4ah0g 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 (2017/01) docid\ cc1mr0qles6tsrkh4ah0g 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 filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results response body returns the number of affected dynamic playlists as an integer value 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 filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results response body the number of dynamic playlists is returned as an integer value 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}/ 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 (2017/01) docid\ cc1mr0qles6tsrkh4ah0g put /{id\ int}/ modifies the specified dynamic playlist instance parameters id int a unique identifier for the dynamic playlist instance request body the dynamic playlists entity (2017/01) docid\ cc1mr0qles6tsrkh4ah0g 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 dynamic playlist from the network parameters 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 get /{name}/ returns the dynamic playlist instance with the specified name parameters name string the name of the dynamic playlist instance response body returns the dynamic playlists entity (2017/01) docid\ cc1mr0qles6tsrkh4ah0g put /{name}/ modifies the specified dynamic playlist instance parameters name string the name of the dynamic playlist instance request body the dynamic playlists entity (2017/01) docid\ cc1mr0qles6tsrkh4ah0g response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{name}/ 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 get /{id\ int}/permissions/ includes object permissions for a given dynamic playlist instance parameters id int a unique identifier for the dynamic playlist instance response body returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{id\ int}/permissions/ adds permissions to the specified dynamic playlist instance parameters id int a unique identifier for the dynamic 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 dynamic playlist parameters id int a unique identifier for the dynamic 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 dynamic playlist instance parameters name string the name of the dynamic playlist instance response body returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{name}/permissions/ adds permissions to the specified dynamic playlist instance parameters name string the name of the dynamic 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 dynamic playlist parameters name string the name of the dynamic 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