POST /
Creates a live text feed on a network
Required Scope Token
bsn.api.main.feeds.text.create
______________________________________________________________
Request Body
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
POST /2022/06/REST/Feeds/Text/ HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate Content-Type: application/json Content-Length: 389
This is the example request body:
{ "id": 0, "name": "Breakfast Menu", "physicalPath": null, "fileSize": 0, "fileHash": null, "creationDate": "0001-01-01T00:00:00", "lastModifiedDate": "0001-01-01T00:00:00", "items": [ { "title": "Hamburger: $9.99", "description": "Ground chuck, onion, Worcestershire sauce & seasonings.", "validityStartDate": "2023-11-01T00:00:00Z", "validityEndDate": "2023-12-01T00:00:00Z" } ], "presentations": null, "permissions": [] }
______________________________________________________________
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.
Example
{ "id": 2345678, "name": "Price List", "physicalPath": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/Feeds/d1df209dfa240a5e5e74657c76f46cf3", "fileSize": 159, "fileHash": "SHA1:5BE7EDB6A8FBHAA23894114C185CD8AFD9A8E279", "creationDate": "2023-10-06T19:43:47.597Z", "lastModifiedDate": "2023-10-06T19:43:47.597Z", "items": [ { "title": "Hamburger: $9.99", "description": "Ground chuck, onion, Worcestershire sauce & seasonings.", "validityStartDate": "2023-11-01T00:00:00Z", "validityEndDate": "2023-12-01T00:00:00Z" } ], "presentations": [], "permissions": [] }
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, or it is rejected in accordance with the business rules
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
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 Parameter
filter
string required
An expression for filtering search results
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
filter
is set to[Name] IS 'Price List'
DELETE /2022/06/REST/Feeds/Text/?filter=%5BName%5D%20IS%20%27Price List%27 HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate
______________________________________________________________
Response
Success Response Body
200: Returns the number of affected live text feeds 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 or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules
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
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.
Required Scope Token
bsn.api.main.feeds.text.retrieve
______________________________________________________________
Query String Parameter
filter
string optional
An expression for filtering search results
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
filter
is set to[Name] CONTAINS 'Test'
GET /2022/06/REST/Feeds/Text/Count/?filter=%20%5BName%5D%20CONTAINS%20%27Test%27 HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate
______________________________________________________________
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
GET /{id:int}/
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
id
is set to234567
The optional
If-Modified-Since
header value equals theLast-Modified
header value retrieved from the previousGET /id
orGET /name
response
GET /2022/06/REST/Feeds/Text/234567/ HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} If-Modified-Since: Wed, 3 Jan 2024 20:33:34 GMT Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate
______________________________________________________________
Response
Success Response with Body
200: Returns the Live Text Feed Entity
Example
This is a 200 response example:
{ "id": 234567, "name": "Test2", "physicalPath": "https://bsncloud.s3.amazonaws.com/JohnDoeTesting/Feeds/f2a442416bd2c6876bf16a19f8d21457", "fileSize": 161, "fileHash": "SHA1:85F4B1A9F50C55631E8398EA68467B34EFF00E8C", "creationDate": "2023-10-24T17:50:40.237Z", "lastModifiedDate": "2024-01-03T20:33:35.093Z", "items": [], "presentations": [], "permissions": [] }
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
PUT /{id:int}/
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
id
is set to12345
The optional
If-Unmodified-Since
header value equals theLast-Modified
header value retrieved from theGET /id
orGET /name
response.
PUT /2022/06/REST/Feeds/Text/12345/ HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate If-Unmodified-Since: Wed, 3 Jan 2024 20:33:34 GMT Content-Type: application/json Content-Length: 398
This is the example request body:
{ "id": 0, "name": "Breakfast Menu", "physicalPath": null, "fileSize": 0, "fileHash": null, "creationDate": "0001-01-01T00:00:00", "lastModifiedDate": "0001-01-01T00:00:00", "items": [ { "title": "Hamburger: $9.99", "description": "Ground chuck, onion, Worcestershire sauce & seasonings.", "validityStartDate": "2023-11-01T00:00:00Z", "validityEndDate": "2023-12-01T00:00:00Z" } ], "presentations": null, "permissions": [] }
______________________________________________________________
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: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules
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
DELETE /{id:int}/
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
id
is set to12345
The optional
If-Unmodified-Since
header value equals theLast-Modified
header value retrieved from theGET /id
orGET /name
response.
DELETE /2022/06/REST/Feeds/Text/12345/ HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} If-Unmodified-Since: Wed, 3 Jan 2024 20:33:34 GMT Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate
______________________________________________________________
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 or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules
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
GET /{name}/
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
name
is set toNewsFeed
The optional
If-Modified-Since
header value equals theLast-Modified
header value retrieved from the previousGET /id
orGET /name
response
GET /2022/06/REST/Feeds/Text/NewsFeed/ HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} If-Modified-Since: Wed, 3 Jan 2024 20:33:34 GMT Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate
______________________________________________________________
Response
Success Response with Body
200: Returns the Live Text Feed Entity
Example
This is a 200 response example:
{ "id": 12345, "name": "NewsFeed", "physicalPath": "https://bsncloud.s3.amazonaws.com/JohnDoeTesting/Feeds/f8a442416bd2c6876bf16a19f8d21457", "fileSize": 161, "fileHash": "SHA1:85F4B1A9F50C45631E8398EA68497B34E0F00E8C", "creationDate": "2023-10-24T17:50:40.237Z", "lastModifiedDate": "2023-10-24T17:50:40.237Z", "items": [], "presentations": [], "permissions": [] }
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
PUT /{name}/
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
name
is set toNewsFeed
The optional
If-Unmodified-Since
header value equals theLast-Modified
header value retrieved from theGET /id
orGET /name
response.
PUT /2022/06/REST/Feeds/Text/NewsFeed/ HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate If-Unmodified-Since: Wed, 3 Jan 2024 20:33:34 GMT Content-Type: application/json Content-Length: 398
This is the example request body:
{ "id": 0, "name": "Breakfast Menu", "physicalPath": null, "fileSize": 0, "fileHash": null, "creationDate": "0001-01-01T00:00:00", "lastModifiedDate": "0001-01-01T00:00:00", "items": [ { "title": "Hamburger: $9.99", "description": "Ground chuck, onion, Worcestershire sauce & seasonings.", "validityStartDate": "2023-11-01T00:00:00Z", "validityEndDate": "2023-12-01T00:00:00Z" } ], "presentations": null, "permissions": [] }
______________________________________________________________
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: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules
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
DELETE /{name}/
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
name
is set toNewsFeed
The optional
If-Unmodified-Since
header value equals theLast-Modified
header value retrieved from theGET /id
orGET /name
response.
DELETE /2022/06/REST/Feeds/Text/NewsFeed/ HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} If-Unmodified-Since: Wed, 3 Jan 2024 20:33:34 GMT Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate
______________________________________________________________
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 or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules
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
GET /Operations/
Returns operational permissions granted to roles for specific business operations
Required Scope Token
bsn.api.main.operations.retrieve
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
GET /2022/06/REST/Feeds/Text/Operations/ HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate
______________________________________________________________
Response
Success Response Body
200: Returns the Business Operations Entity
Example
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
GET /{id:int}/Permissions/
Includes 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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
id
is set to4567890
GET /2022/06/REST/Feeds/Text/4567890/Permissions/ HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate
______________________________________________________________
Response
Success Response Body
200: Returns an array of Permission entities
Example
[ { "entityId": 4567890, "operationUID": "5ef4d2e0-3abc-4f3d-aa8f-d1bbddace601", "principal": { "name": "Custom", "isCustom": true, "type": "Role", "id": 10498 }, "isFixed": false, "isInherited": false, "isAllowed": false, "creationDate": "2023-10-27T18:48:11.05Z" }, { "entityId": 4567890, "operationUID": "376563fa-72b4-471a-9d49-1f4de927dc20", "principal": { "login": "JaneDoe@brightsign.biz", "type": "User", "id": 10498 }, "isFixed": false, "isInherited": false, "isAllowed": false, "creationDate": "2023-10-27T18:48:11.057Z" } ]
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
POST /{id:int}/Permissions/
Adds permissions to live text feeds instance(s) with the specified id.
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
id
is set to4567890
POST /2022/06/REST/Feeds/Text/4567890/Permissions/ HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate Content-Type: application/json Content-Length: 368
This is the example request body:
[ { "entityId": 4567890, "operationUID": "376563fa-72b4-471a-9d49-1f4de927dc20", "principal": { "name": "Custom", "isCustom": true, "type": "Role", "id": 10498 }, "isFixed": false, "isInherited": false, "isAllowed": false, "creationDate": "2023-10-27T18:48:11.057Z" } ]
______________________________________________________________
Response
Success
204: The specified permissions were successfully granted
Failure
400: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules
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
DELETE /{id:int}/Permissions/
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
id
is set to4567890
DELETE /2022/06/REST/Feeds/Text/4567890/Permissions/ HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate Content-Type: application/json Content-Length: 328
This is the example request body:
[ { "entityId": 4567890, "operationUID": "5ef4d2e0-3abc-4f3d-aa8f-d1bbddace601", "principal": { "name": "Custom", "isCustom": true, "type": "Role", "id": 10498 }, "isFixed": false, "isInherited": false, "isAllowed": false, "creationDate": "2023-10-27T18:48:11.05Z" }, { "entityId": 4567890, "operationUID": "376563fa-72b4-471a-9d49-1f4de927dc20", "principal": { "login": "JaneDoe@brightsign.biz", "type": "User", "id": 10498 }, "isFixed": false, "isInherited": false, "isAllowed": false, "creationDate": "2023-10-27T18:48:11.057Z" } ]
______________________________________________________________
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, or it is rejected in accordance with the business rules
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
GET /{name}/Permissions/
Includes 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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
name
is set toNewsFeed
GET /2022/06/REST/Feeds/Text/NewsFeed/Permissions/ HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate
______________________________________________________________
Response
Success Response Body
200: Returns an array of Permission entities
Example
[ { "entityId": 4567890, "operationUID": "5ef4d2e0-3abc-4f3d-aa8f-d1bbddace601", "principal": { "name": "Custom", "isCustom": true, "type": "Role", "id": 10498 }, "isFixed": false, "isInherited": false, "isAllowed": false, "creationDate": "2023-10-27T18:48:11.05Z" }, { "entityId": 4567890, "operationUID": "376563fa-72b4-471a-9d49-1f4de927dc20", "principal": { "login": "JaneDoe@brightsign.biz", "type": "User", "id": 10498 }, "isFixed": false, "isInherited": false, "isAllowed": false, "creationDate": "2023-10-27T18:48:11.057Z" } ]
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
POST /{name}/Permissions/
Adds permissions to live text feeds instance(s) with the specified name.
Required Scope Token
bsn.api.main.feeds.text.update
______________________________________________________________
Segment
name
string
The name of the live text feed instance
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
name
is set toNewsFeed
POST /2022/06/REST/Feeds/Text/NewsFeed/Permissions/ HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate Content-Type: application/json Content-Length: 368
This is the example request body:
[ { "entityId": 4567890, "operationUID": "376563fa-72b4-471a-9d49-1f4de927dc20", "principal": { "name": "Custom", "isCustom": true, "type": "Role", "id": 10498 }, "isFixed": false, "isInherited": false, "isAllowed": false, "creationDate": "2023-10-27T18:48:11.057Z" } ]
______________________________________________________________
Response
Success
204: The specified permissions were successfully granted
Failure
400: The request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules
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
DELETE /{name}/Permissions/
Removes permissions from 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
An array of Permission entities
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
name
is set toNewsFeed
DELETE /2022/06/REST/Feeds/Text/NewsFeed/Permissions/ HTTP/1.1 Host: api.bsn.cloud Connection: Keep-Alive Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json Accept-Encoding: gzip,deflate Content-Type: application/json Content-Length: 328
This is the example request body:
[ { "entityId": 4567890, "operationUID": "5ef4d2e0-3abc-4f3d-aa8f-d1bbddace601", "principal": { "name": "Custom", "isCustom": true, "type": "Role", "id": 10498 }, "isFixed": false, "isInherited": false, "isAllowed": false, "creationDate": "2023-10-27T18:48:11.05Z" }, { "entityId": 4567890, "operationUID": "376563fa-72b4-471a-9d49-1f4de927dc20", "principal": { "login": "JaneDoe@brightsign.biz", "type": "User", "id": 10498 }, "isFixed": false, "isInherited": false, "isAllowed": false, "creationDate": "2023-10-27T18:48:11.057Z" } ]
______________________________________________________________
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, or it is rejected in accordance with the business rules
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