Versions Compared

Old Version 75

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 76

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: added error codes

Use these endpoints to manage live text feeds on the network.

Base URL for these endpoints:  https://api.bsn.cloud/2020/10/REST/Feeds/Text/

_________________________________________________________________________

GET

Returns a list of live text feeds on a network

Query String Parameters

filter string optional 

An expression for filtering search results. The default value is null.


sort string 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 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 text feed instances exceeds the pageSize.

This parameter is only required if you need more elements in the paged list than the pageSize (100).


pageSize int optional 

The maximum number of text feed instances that can be contained in the response body. This defaults to the maximum allowed page size (100).

______________________________________________________________

Response 

Success Response Body

200: 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.

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

POST

Creates a live text feed on a network

Request Body

The Live Text Feed Entity

______________________________________________________________

Response

Success Response Body

201: Returns the Live Text Feed Entity created and referenced by the Uri (given by the Location header field) in the response. 

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: Either the request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

Endpoints:

Table of Contents
maxLevel2
indent20px
excludeEndpoints:



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.

Query String Parameters

filter string required 

An expression for filtering search results

______________________________________________________________

Response

Success Response Body

200: Returns the number of affected live text feed instances as an integer value

.

Failure

400

300: The

request is

requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Endpoints:

Table of ContentsmaxLevel

2indent20pxexcludeEndpoints:


Count/GET

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. 

Query String Parameters

filter string 

An expression for filtering search results

______________________________________________________________

Response 

Success Response Body

200: The number of live text feeds is returned as an integer value.

Failure

{id:int}/GET

Returns the specified live text feeds instance

Segment

id int

A unique identifier for the live text feed instance

____300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error


{id:int}/GET

Returns the specified live text feeds instance

Segment

id int

A unique identifier for the live text feed instance

______________________________________________________________

Response

Success Response with Body

200: Returns the Live Text Feed Entity

{id:int}/PUT

Modifies the specified live text feed instance

Segment

id int

A unique identifier for the live text feed instance

______________________________________________________________

Request Body

The Live Text Feed Entity

_________________

Success Response

304: The resource was not modified since the time specified in the “If-Modified-Since” header

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{id:int}/PUT

Modifies the specified live text feed instance

Segment

id int

A unique identifier for the live text feed instance

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

{id:int}/DELETE

Removes the specified live text feed instance

Segment

id int

A unique identifier for the live text feed instance

Request Body

The Live Text Feed Entity

______________________________________________________________

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.

{name}/GET

Returns the specified live text feeds instance

Segment

name string 

The name of the live text feed instance

______________________________________________________________

Response Body

Returns the Live Text Feed Entity

{name}/PUT

Modifies the specified live text feed instance

Segment

name string 

The name of the live text feed instance

___________________

Success

204: The specified live text feed instance has been updated 

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: Either the request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

412: Precondition failed (the resource/live text feed instance changed since the time specified in the “If-Unmodified-Since” header value)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

{id:int}/DELETE

Removes the specified live text feed instance

Segment

id int

A unique identifier for the live text feed instance

___________________________________________

Request Body

The Live Text Feed Entity

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

{name}/DELETE

Removes the specified live text feed instance 

Segment

name string 

The name of the live text feed instance

________________________________

Response

Success

204: The specified live text feed has been deleted 

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)

5XX: Any 500 code is an internal server error

{name}/GET

Returns the specified live text feeds instance

Segment

name string 

The name of 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.

Operations/GET

Returns operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity

{id:int}/Permissions/GET

Returns object permissions for a given live text feed instance.

Segment

id int

A unique identifier for

Success Response with Body

200: Returns the Live Text Feed Entity

Success Response

304: The resource was not modified since the time specified in the “If-Modified-Since” header

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{name}/PUT

Modifies the specified live text feed instance

Segment

name string 

The name of the live text feed instance

______________________________________________________________

Response

Request Body

Success

200: Returns an array of Permission entities 

{id:int}/Permissions/POST

Adds permissions to live text feeds instance(s) with the specified id.

Segment

id int

A unique identifier for the live text feed instance

The Live Text Feed Entity

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

{id:int}/Permissions/DELETE

Removes permissions from the specified live text feed instance. 

Segment

id int

A unique identifier for the live text feed instance

______________________________________________________________

Request Body

An array of Permission entities

Response

Success

204: The specified live text feed instance has been updated  

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: Either the request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

412: Precondition failed (the resource/live text feed instance changed since the time specified in the “If-Unmodified-Since” header value)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

{name}/DELETE

Removes the specified live text feed instance 

Segment

name string 

The name of the live text feed instance

______________________________________________________________

Response

Success

204: The specified live text feed has been deleted

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)

5XX: Any 500 code is an internal server erro

Operations/GET

Returns operational permissions granted to roles for specific business operations

Response

Success Response Body

200: Returns the Business Operations Entity

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{id:int}/Permissions/GET

Returns object permissions for a given live text feed instance.

Segment

id int

A unique identifier for the live text feed instance

______________________________________________________________

Response

Success Response Body

200: Returns an array of Permission entities 

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{id:int}/Permissions/POST

Adds permissions to the specified live text feeds instance(s)

Segment

id int

A unique identifier for the live text feed instance

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Response

Success

204: The specified permissions were successfully granted

Failure

400: The request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

{id:int}/Permissions/DELETE

Removes permissions from the specified live text feed instance

Segment

id int

A unique identifier for the live text feed instance

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Response Body

Success

204: The specified permissions were successfully deleted  

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{name}/Permissions/GET

Returns object permissions for a given live text feed instance

Segment

name string 

The name of the live text feed instance

______________________________________________________________

Response

Success Response Body

200: Returns an array of Permission entities 

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error


{name}/Permissions/POST

Adds permissions to the specified live text feed(s)

Segment

name string 

The name of the live text feed 

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

{name}/Permissions/GET

Returns object permissions for a given live text feed instance.

Segment

name string 

The name of the live text feed instance

Request Body

An array of Permission entities

______________________________________________________________

Response Body

Success

200: Returns an array of Permission entities 

Response

Success

204: The specified permissions were successfully granted

Failure

400: The request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

415:  The specified representation of the permissions entity is invalid or not supported (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

Adds permissions to live text feeds instance(s) with the specified name.

Segment

name string 

The name of the live text feed instance

______________________________________________________________

Request Body

An array of Permission entities

{name}/Permissions/

POST

DELETE

Removes permissions from the specified live text feed

Segment

name string 

The name of the live text feed

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

{name}/Permissions/DELETE

Removes permissions from the specified live text feed instance. 

Segment

name string 

The name of the live text feed instance

Request Body

An array of Permission entities

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX._______________________________

Response

Success

204: The specified permissions were successfully deleted  

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error