BrightSignNetwork (BSN) Main A...
Main REST HTTP API version 201...

Feeds/Text Endpoints (2017/01)

12min
use these endpoints to manage live text feeds on the network base url for these endpoints https //api brightsignnetwork com/2017/01/rest/feeds/text get / returns a list of live text feeds on a 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 text feed instances exceeds the pagesize pagesize int the maximum number of text feed instances that can be contained in the response body response body returns a paged list entity (2017/01) docid\ yn3gu asyfisjdxgbjdvb of live text feed entity (2017/01) docid\ epngeboo9zwz pgx4rnb6 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 live text feed on a network request body the live text feed entity (2017/01) docid\ epngeboo9zwz pgx4rnb6 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 live text feed entity (2017/01) docid\ epngeboo9zwz pgx4rnb6 delete / removes live text feed instances, specified by a filter, from a network this allows multiple live text feed instances 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 live text feeds as an integer value get /count/ returns the number of live text feeds on the network that match the specified filter criteria if no filter is included, this call returns the total number of live text feeds 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 live text feeds is returned as an integer value get /{id\ int}/ returns the live text feeds instance with the specified id parameters id int a unique identifier for the live text feed instance response body returns the live text feed entity (2017/01) docid\ epngeboo9zwz pgx4rnb6 put /{id\ int}/ modifies the specified live text feed instance parameters id int a unique identifier for the live text feed instance request body the live text feed entity (2017/01) docid\ epngeboo9zwz pgx4rnb6 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 live media text instance from the network parameters id int a unique identifier for the live text feed instance response body on success this method returns a status code 2xx, code 404 if the live media feed instance could not be found, or code of 5xx on failure get /{name}/ returns the live text feeds instance for the specified name parameters name string a unique identifier for the live text feed instance response body returns the live text feed entity (2017/01) docid\ epngeboo9zwz pgx4rnb6 put /{name}/ modifies the specified live text feed instance parameters name string a unique identifier for the live text feed instance request body the live text feed entity (2017/01) docid\ epngeboo9zwz pgx4rnb6 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 live text feed instance from the network parameters name string a unique identifier for the live text feed instance response body on success this method returns a status code 2xx, code 404 if the live media feed instance could not be found, or code of 5xx on failure get /operations/ returns 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 live text feed instance parameters id int a unique identifier for the live text feed instance response body returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{id\ int}/permissions/ adds permissions to live text feeds instance(s) with the specified id parameters id int a unique identifier for the live text feed 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 from the specified live text feed instance parameters id int a unique identifier for the live text feed 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 live text feed instance parameters name string a unique identifier for the live text feed instance response body returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{name}/permissions/ adds permissions to live text feeds instance(s) with the specified name parameters name string a unique identifier for the live text feed 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 from the specified live text feed instance parameters name string a unique identifier for the live text feed 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