- Created by BrightSign TechDocs, last modified on Jun 27, 2024
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 17 Current »
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 expression 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 of Live Text Feed Entity 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
______________________________________________________________
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.
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 expression 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 expression 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
PUT /{id:int}/
Modifies the specified live text feed instance.
Parameters
id int
A unique identifier for the live text feed instance
______________________________________________________________
Request Body
______________________________________________________________
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
PUT /{name}/
Modifies the specified live text feed instance.
Parameters
name string
A unique identifier for the live text feed instance
______________________________________________________________
Request Body
______________________________________________________________
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
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
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
______________________________________________________________
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
______________________________________________________________
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
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
______________________________________________________________
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
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
Endpoints:
- No labels