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.
Required Scope Token
bsn.api.main.feeds.text.delete
______________________________________________________________
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
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
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.
Required Scope Token
bsn.api.main.feeds.text.retrieve
______________________________________________________________
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
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
Required Scope Token
bsn.api.main.feeds.text.retrieve
______________________________________________________________
Segment
id int
A unique identifier for the live text feed instance
______________________________________________________________
Response
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
{id:int}/ PUT
Modifies the specified live text feed instance
Required Scope Token
bsn.api.main.feeds.text.update
______________________________________________________________
Segment
id int
A unique identifier for the live text feed instance
______________________________________________________________
Request Body
______________________________________________________________
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
{id:int}/ DELETE
Removes the specified live text feed instance
Required Scope Token
bsn.api.main.feeds.text.delete
______________________________________________________________
Segment
id int
A unique identifier for 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
Required Scope Token
bsn.api.main.feeds.text.retrieve
______________________________________________________________
Segment
name string
The name of the live text feed instance
______________________________________________________________
Response
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
Required Scope Token
bsn.api.main.feeds.text.update
______________________________________________________________
Segment
name string
The name of the live text feed instance
______________________________________________________________
Request Body
______________________________________________________________
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
Required Scope Token
bsn.api.main.feeds.text.delete
______________________________________________________________
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
Required Scope Token
bsn.api.main.operations.retrieve
______________________________________________________________
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.
Required Scope Token
bsn.api.main.feeds.text.retrieve
______________________________________________________________
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)
Required Scope Token
bsn.api.main.feeds.text.update
______________________________________________________________
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
Required Scope Token
bsn.api.main.feeds.text.update
______________________________________________________________
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
Required Scope Token
bsn.api.main.feeds.text.retrieve
______________________________________________________________
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)
Required Scope Token
bsn.api.main.feeds.text.update
______________________________________________________________
Segment
name string
The name of the live text feed
______________________________________________________________
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 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
{name}/Permissions/ DELETE
Removes permissions from the specified live text feed
Required Scope Token
bsn.api.main.feeds.text.update
______________________________________________________________
Segment
name string
The name of the live text feed
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
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