---
title: DeviceWebPages Endpoints (2022/06)
slug: develop/devicewebpages-endpoints-202206
docTags:
createdAt: 2025-03-11T07:03:30.743Z
---
These endpoints allow users to manage device webpages on the network.
Base URL for these endpoints: ***https\://api.bsn.cloud/2022/06/REST/DeviceWebPages***
*\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_*
## GET /
Returns a list of player webpages
**Required Scope Token**
bsn.api.main.devicewebpages.retrieve
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Query String Parameters**
- `filter` string optional: An [expression](docId:3L0afyD3xoOE-yTvfk2vs) 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 (see [this page](docId:3L0afyD3xoOE-yTvfk2vs) for more information). 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 device webpage 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 player webpage instances that can be contained in the response body. This defaults to the maximum allowed page size (100).
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Example**
The example request parameters and headers are set as follows:
- `marker` value is set to the `[PagedList].[NextMarker]` property value from the previous BSN.Cloud API response.
- `pageSize` is set to `1`
- `filter` is set to `[Name] CONTAINS 'Page' AND [UploadDate] IS IN THE RANGE '2020-07-01' AND '2023-11-01'`
- `sort` is set to `[Name] DESC`
```text
GET /2022/06/REST/DeviceWebPages/?marker=TWF0dHNJbnRlcm5hbFBhZ2UsOTczMTk1NQ%3D%3D&pageSize=1&filter=%5BName%5D%20CONTAINS%20%27Page%27%20AND%20%5BUploadDate%5D%20IS%20IN%20THE%20RANGE%20%272020-07-01%27%20AND%20%272023-11-01%27&sort=%5BName%5D%20DESC 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
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Success Response Body**
200: Returns a [paged list](docId\:Pwwr0Ln3-binNgL-mr3St) of [WebPage Entity](docId\:O5V0Ui933WvEREInm7lS7) instances on a network. This will return not more than 100 entities along with the information necessary to return any other remaining pages.
**Example**
```json
{
"items": [ {
"id": 11335061,
"name": "HTML_Red_Dot_Test-WebPage",
"uploadDate": "2023-10-17T14:24:21.63Z",
"lastModifiedDate": "2023-10-17T14:24:21.63Z",
"indexFile": {
"fileName": "village-of-menomonee-falls-events.html",
"physicalPath": "https://bsncloud.s3.amazonaws.com/ContentCloud/ee9d33406bf95280fd4bfa4a03ec9965",
"relativePath": "\\",
"fileSize": 1569,
"fileHash": "SHA1:2614BFE3EC74FEE729FB6EQ291E6324E0432317E"
},
"assets": null,
"presentations": [ {
"id": 242058,
"name": "HTML_Red_Dot_Test",
"type": "Presentation",
"link": null
}],
"permissions": []
}],
"totalItemCount": 9,
"matchingItemCount": 6,
"pageSize": 1,
"nextMarker": "SFRNTF9SZWRfRG90X1Rlc3QtV2ViUGFnZSwxMTM0NTA1MA==",
"prevMarker": "SFRNTF9SZWRfRG90X1Rlc3QtV2ViUGFnZSwxMTM0NTA134hU",
"isTruncated": true,
"sortExpression": "[Name] DESC",
"filterExpression": "[Name] CONTAINS 'Page' AND [UploadDate] IS IN THE RANGE '2020-07-01T00:00:00.000Z' AND '2023-11-01T00:00:00.000Z'"
}
```
**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
## DELETE /
Removes player webpages, specified by a filter, from a network. This allows multiple player webpages to be deleted at once.
**Required Scope Token**
bsn.api.main.devicewebpages.delete
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Query String Parameter**
- `filter` string required: An [expression](docId:3L0afyD3xoOE-yTvfk2vs) for filtering search results. The default value is null.
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Example**
The example request parameters and headers are set as follows:
- `filter` is set to `[UploadDate] IS IN THE RANGE '2020-07-01' AND '2020-08-01'`
```text
DELETE /2022/06/REST/DeviceWebPages/?filter=%5BName%5D%20CONTAINS%20%27Default%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
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Success Response Body**
200: Returns the number of affected player webpages as an integer value.
**Failure Response**
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. For example, you cannot delete a device webpage that is in use by a presentation.
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 player webpages on a device
**Required Scope Token**
bsn.api.main.devicewebpages.retrieve
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Query String Parameter**
- `filter` string optional: An [expression](docId:3L0afyD3xoOE-yTvfk2vs) for filtering search results. The default value is null.
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Example**
The example request parameters and headers are set as follows:
- `filter` is set to `[UploadDate] IS IN THE RANGE '2018-01-01' AND '2023-09-01'`
```text
GET /2022/06/REST/DeviceWebPages/Count/?filter=%5BUploadDate%5D%20IS%20IN%20THE%20RANGE%20%272018-01-01%27%20AND%20%272023-09-01 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
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Success Response Body**
200: The player webpages count is returned as an integer value.
**Failure Response**
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}/
Returns the specified player webpage
**Required Scope Token**
bsn.api.main.devicewebpages.retrieve
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segment**
- `id` int: A unique identifier for the player webpage
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Example**
The example request parameters and headers are set as follows:
- `id` is set to `646879`
- The optional `If-Modified-Since` header value equals the `Last-Modified` header value retrieved from the previous `GET /id` or `GET /name` response
```text
GET /2022/06/REST/DeviceWebPages/646879/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 20 Dec 2023 21:30:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Success Response with Body**
200: Returns the [WebPage Entity](docId\:O5V0Ui933WvEREInm7lS7)
**Example**
This is an example of a 200 level response:
```json
{
"id": 646879,
"name": "Default_PresentationWebPage",
"uploadDate": "2020-07-27T16:23:35Z",
"lastModifiedDate": "2023-12-20T21:30:35.093Z",
"indexFile": {
"fileName": "_deviceWebPage.html",
"physicalPath": "https://bsncloud.s3.amazonaws.com/Testing/5ced8fc8c47741c190a19c41f56c85d3",
"relativePath": "\\",
"fileSize": 116305,
"fileHash": "SHA1:F84HF1B0D0361BDC4C2072EBE8C21B16P0HA0031"
},
"assets": [],
"presentations": [
{
"id": 15762,
"name": "CC_Testing",
"type": "Presentation",
"link": null
}
],
"permissions": []
}
```
**Success Response**
304: The resource was not modified since the time specified in the “If-Modified-Since” header
**Failure Response**
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
## DELETE /\{id}/
Deletes the specified player webpage
**Required Scope Token**
bsn.api.main.devicewebpages.delete
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segment**
- `id` int: A unique identifier for the player webpage to delete
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Example**
The example request parameters and headers are set as follows:
- `id` is set to `646879`
- The optional `If-Unmodified-Since` header value equals the `Last-Modified` header value retrieved from the `GET /id` or `GET /name` response.
```text
DELETE /2022/06/REST/DeviceWebPages/646879/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Unmodified-Since: Wed, 20 Dec 2023 21:30:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Success Response**
204: The specified player webpage(s) were deleted
**Failure Response**
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. For example, you cannot delete a device webpage that is in use by a presentation.
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 player webpage
**Required Scope Token**
bsn.api.main.devicewebpages.retrieve
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segment**
- `name` string: The name of the player webpage
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Example**
The example request parameters and headers are set as follows:
- `name` is set to `Default_PresentationWebPage`
- The optional `If-Modified-Since` header value equals the `Last-Modified` header value retrieved from the previous `GET /id` or `GET /name` response
```text
GET /2022/06/REST/DeviceWebPages/Default_PresentationWebPage/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 20 Dec 2023 21:30:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Success Response with Body**
200: Returns the [WebPage Entity](docId\:O5V0Ui933WvEREInm7lS7)
**Example**
This is an example of a 200 level response:
```json
{
"id": 646879,
"name": "Default_PresentationWebPage",
"uploadDate": "2020-07-27T16:23:35Z",
"lastModifiedDate": "2023-12-20T21:30:35.093Z",
"indexFile": {
"fileName": "_deviceWebPage.html",
"physicalPath": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/5ced8fc8c47741c190a19c41f56c85d3",
"relativePath": "\\",
"fileSize": 116305,
"fileHash": "SHA1:F841N1A0D4351BDC4C2072EBC8C21B1550DA0061"
},
"assets": [],
"presentations": [
{
"id": 15762,
"name": "CC_Testing",
"type": "Presentation",
"link": null
}
],
"permissions": []
}
```
**Success Response**
304: The resource was not modified since the time specified in the “If-Modified-Since” header
**Failure Response**
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
## DELETE /\{name}/
Deletes the specified player webpage
**Required Scope Token**
bsn.api.main.devicewebpages.delete
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segment**
- `name` string: The name of the player webpage to delete
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Example**
The example request parameters and headers are set as follows:
- `name` is set to `Default_PresentationWebPage`
- The optional `If-Unmodified-Since` header value equals the `Last-Modified` header value retrieved from the `GET /id` or `GET /name` response.
```text
DELETE /2022/06/REST/DeviceWebPages/Default_PresentationWebPage/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Unmodified-Since: Wed, 20 Dec 2023 21:30:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Success Response**
204: The specified player webpage(s) were deleted
**Failure Response**
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. For example, you cannot delete a device webpage that is in use by a presentation.
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:
```text
GET /2022/06/REST/DeviceWebPages/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
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Success Response Body**
200: Returns the [Business Operations Entity](docId\:eI98k7OUl6z5i-5B-D6js)
:::ExpandableHeading
Example
```json
{
"uid": "74c0bd18-cb38-4a7a-b78d-127ffd5716d0",
"singularName": "Full Control",
"pluralName": "Device Web Page (Full Control)",
"fullName": "Device Web Page (Full Control)",
"targetEntity": "DeviceWebPage",
"appliance": "Instance, Collection",
"parent": null,
"descendants": [
{
"uid": "b484e2f0-af97-41a2-996f-731816e907af",
"singularName": "View Device Web Page",
"pluralName": "View Device Web Pages",
"fullName": "Device Web Page (Full Control) - View Device Web Pages",
"targetEntity": "DeviceWebPage",
"appliance": "Instance, Collection",
"parent": {
"uid": "74c0bd18-cb38-4a7a-b78d-127ffd5716d0",
"singularName": "Full Control",
"pluralName": "Device Web Page (Full Control)",
"fullName": "Device Web Page (Full Control)",
"targetEntity": "DeviceWebPage",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "b484e2f0-af97-41a2-996f-731816e907af",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:06.553Z"
},
{
"entityId": null,
"operationUID": "b484e2f0-af97-41a2-996f-731816e907af",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:07.067Z"
},
{
"entityId": null,
"operationUID": "b484e2f0-af97-41a2-996f-731816e907af",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.08Z"
},
{
"entityId": null,
"operationUID": "b484e2f0-af97-41a2-996f-731816e907af",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.34Z"
},
{
"entityId": null,
"operationUID": "b484e2f0-af97-41a2-996f-731816e907af",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.587Z"
},
{
"entityId": null,
"operationUID": "b484e2f0-af97-41a2-996f-731816e907af",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:05.907Z"
}
]
},
{
"uid": "fecc26f4-31aa-4a7a-a206-afabf885d1e6",
"singularName": "Upload Device Web Page",
"pluralName": "Upload Device Web Page",
"fullName": "Device Web Page (Full Control) - Upload Device Web Page",
"targetEntity": "DeviceWebPage",
"appliance": "Collection",
"parent": {
"uid": "74c0bd18-cb38-4a7a-b78d-127ffd5716d0",
"singularName": "Full Control",
"pluralName": "Device Web Page (Full Control)",
"fullName": "Device Web Page (Full Control)",
"targetEntity": "DeviceWebPage",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "fecc26f4-31aa-4a7a-a206-afabf885d1e6",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.08Z"
},
{
"entityId": null,
"operationUID": "fecc26f4-31aa-4a7a-a206-afabf885d1e6",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.34Z"
},
{
"entityId": null,
"operationUID": "fecc26f4-31aa-4a7a-a206-afabf885d1e6",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.587Z"
},
{
"entityId": null,
"operationUID": "fecc26f4-31aa-4a7a-a206-afabf885d1e6",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:05.907Z"
},
{
"entityId": null,
"operationUID": "fecc26f4-31aa-4a7a-a206-afabf885d1e6",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:06.54Z"
},
{
"entityId": null,
"operationUID": "fecc26f4-31aa-4a7a-a206-afabf885d1e6",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:07.053Z"
}
]
},
{
"uid": "5c6ef943-d660-4907-aa56-e91903ff1772",
"singularName": "Update Device Web Page",
"pluralName": "Update Device Web Page",
"fullName": "Device Web Page (Full Control) - Update Device Web Page",
"targetEntity": "DeviceWebPage",
"appliance": "Instance, Collection",
"parent": {
"uid": "74c0bd18-cb38-4a7a-b78d-127ffd5716d0",
"singularName": "Full Control",
"pluralName": "Device Web Page (Full Control)",
"fullName": "Device Web Page (Full Control)",
"targetEntity": "DeviceWebPage",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "5c6ef943-d660-4907-aa56-e91903ff1772",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.08Z"
},
{
"entityId": null,
"operationUID": "5c6ef943-d660-4907-aa56-e91903ff1772",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.34Z"
},
{
"entityId": null,
"operationUID": "5c6ef943-d660-4907-aa56-e91903ff1772",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.587Z"
},
{
"entityId": null,
"operationUID": "5c6ef943-d660-4907-aa56-e91903ff1772",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:05.907Z"
},
{
"entityId": null,
"operationUID": "5c6ef943-d660-4907-aa56-e91903ff1772",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:06.54Z"
},
{
"entityId": null,
"operationUID": "5c6ef943-d660-4907-aa56-e91903ff1772",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:07.053Z"
}
]
},
{
"uid": "ba132cfb-475f-44ab-bfe5-eeadb23af065",
"singularName": "Assign Device Web Page",
"pluralName": "Assign Device Web Page",
"fullName": "Device Web Page (Full Control) - Assign Device Web Page",
"targetEntity": "DeviceWebPage",
"appliance": "Instance, Collection",
"parent": {
"uid": "74c0bd18-cb38-4a7a-b78d-127ffd5716d0",
"singularName": "Full Control",
"pluralName": "Device Web Page (Full Control)",
"fullName": "Device Web Page (Full Control)",
"targetEntity": "DeviceWebPage",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "ba132cfb-475f-44ab-bfe5-eeadb23af065",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.08Z"
},
{
"entityId": null,
"operationUID": "ba132cfb-475f-44ab-bfe5-eeadb23af065",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.34Z"
},
{
"entityId": null,
"operationUID": "ba132cfb-475f-44ab-bfe5-eeadb23af065",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.587Z"
},
{
"entityId": null,
"operationUID": "ba132cfb-475f-44ab-bfe5-eeadb23af065",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:05.907Z"
},
{
"entityId": null,
"operationUID": "ba132cfb-475f-44ab-bfe5-eeadb23af065",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:06.54Z"
},
{
"entityId": null,
"operationUID": "ba132cfb-475f-44ab-bfe5-eeadb23af065",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:07.053Z"
}
]
},
{
"uid": "e0a3a34b-74d9-46ac-a2f5-d03674cb9ac3",
"singularName": "Unassign Device Web Page",
"pluralName": "Unassign Device Web Page",
"fullName": "Device Web Page (Full Control) - Unassign Device Web Page",
"targetEntity": "DeviceWebPage",
"appliance": "Instance, Collection",
"parent": {
"uid": "74c0bd18-cb38-4a7a-b78d-127ffd5716d0",
"singularName": "Full Control",
"pluralName": "Device Web Page (Full Control)",
"fullName": "Device Web Page (Full Control)",
"targetEntity": "DeviceWebPage",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "e0a3a34b-74d9-46ac-a2f5-d03674cb9ac3",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.08Z"
},
{
"entityId": null,
"operationUID": "e0a3a34b-74d9-46ac-a2f5-d03674cb9ac3",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.34Z"
},
{
"entityId": null,
"operationUID": "e0a3a34b-74d9-46ac-a2f5-d03674cb9ac3",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.587Z"
},
{
"entityId": null,
"operationUID": "e0a3a34b-74d9-46ac-a2f5-d03674cb9ac3",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:05.907Z"
},
{
"entityId": null,
"operationUID": "e0a3a34b-74d9-46ac-a2f5-d03674cb9ac3",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:06.54Z"
},
{
"entityId": null,
"operationUID": "e0a3a34b-74d9-46ac-a2f5-d03674cb9ac3",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:07.053Z"
}
]
},
{
"uid": "136c2201-f5f9-4f16-be52-35db9b1444d0",
"singularName": "Edit Permissions",
"pluralName": "Edit Permissions",
"fullName": "Device Web Page (Full Control) - Edit Permissions",
"targetEntity": "DeviceWebPage",
"appliance": "Collection",
"parent": {
"uid": "74c0bd18-cb38-4a7a-b78d-127ffd5716d0",
"singularName": "Full Control",
"pluralName": "Device Web Page (Full Control)",
"fullName": "Device Web Page (Full Control)",
"targetEntity": "DeviceWebPage",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "136c2201-f5f9-4f16-be52-35db9b1444d0",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.08Z"
},
{
"entityId": null,
"operationUID": "136c2201-f5f9-4f16-be52-35db9b1444d0",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.34Z"
},
{
"entityId": null,
"operationUID": "136c2201-f5f9-4f16-be52-35db9b1444d0",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.587Z"
},
{
"entityId": null,
"operationUID": "136c2201-f5f9-4f16-be52-35db9b1444d0",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:05.907Z"
},
{
"entityId": null,
"operationUID": "136c2201-f5f9-4f16-be52-35db9b1444d0",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:06.54Z"
},
{
"entityId": null,
"operationUID": "136c2201-f5f9-4f16-be52-35db9b1444d0",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:07.053Z"
}
]
},
{
"uid": "220b7755-3d09-4934-b583-69beb2d4976a",
"singularName": "Delete Device Web Page",
"pluralName": "Delete Device Web Page",
"fullName": "Device Web Page (Full Control) - Delete Device Web Page",
"targetEntity": "DeviceWebPage",
"appliance": "Instance, Collection",
"parent": {
"uid": "74c0bd18-cb38-4a7a-b78d-127ffd5716d0",
"singularName": "Full Control",
"pluralName": "Device Web Page (Full Control)",
"fullName": "Device Web Page (Full Control)",
"targetEntity": "DeviceWebPage",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "220b7755-3d09-4934-b583-69beb2d4976a",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:06.567Z"
},
{
"entityId": null,
"operationUID": "220b7755-3d09-4934-b583-69beb2d4976a",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.08Z"
},
{
"entityId": null,
"operationUID": "220b7755-3d09-4934-b583-69beb2d4976a",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.34Z"
},
{
"entityId": null,
"operationUID": "220b7755-3d09-4934-b583-69beb2d4976a",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.587Z"
},
{
"entityId": null,
"operationUID": "220b7755-3d09-4934-b583-69beb2d4976a",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:05.907Z"
},
{
"entityId": null,
"operationUID": "220b7755-3d09-4934-b583-69beb2d4976a",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:07.053Z"
}
]
}
],
"permissions": [
{
"entityId": null,
"operationUID": "74c0bd18-cb38-4a7a-b78d-127ffd5716d0",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.08Z"
},
{
"entityId": null,
"operationUID": "74c0bd18-cb38-4a7a-b78d-127ffd5716d0",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.34Z"
},
{
"entityId": null,
"operationUID": "74c0bd18-cb38-4a7a-b78d-127ffd5716d0",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2020-03-05T16:59:05.587Z"
},
{
"entityId": null,
"operationUID": "74c0bd18-cb38-4a7a-b78d-127ffd5716d0",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": false,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:05.907Z"
},
{
"entityId": null,
"operationUID": "74c0bd18-cb38-4a7a-b78d-127ffd5716d0",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": false,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:06.54Z"
},
{
"entityId": null,
"operationUID": "74c0bd18-cb38-4a7a-b78d-127ffd5716d0",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": false,
"isAllowed": false,
"creationDate": "2020-03-05T16:59:07.053Z"
}
]
}
```
:::
**Failure Response**
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}/Permissions/
Includes object permissions for a given player webpage instance.
**Required Scope Token**
bsn.api.main.devicewebpages.retrieve
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segment**
- `id` int: A unique identifier for the player webpage
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Example**
The example request parameters and headers are set as follows:
- `id` is set to `646879`
```text
GET /2022/06/REST/DeviceWebPages/646879/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
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Success Response Body**
200: Returns an array of [Permission](docId\:JWfyMC42cdRG5jY2SkYsU) entities
**Example**
```json
[
{
"entityId": 546701,
"operationUID": "5c6ef943-d660-4907-aa56-e91903ff1772",
"principal": {
"login": "JaneDoe@brightsign.biZ",
"type": "User",
"id": 102359
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-11T18:46:30.1Z"
}
]
```
**Failure Response**
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}/Permissions/
Adds permissions for a player webpage
**Required Scope Token**
bsn.api.main.devicewebpages.update
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segment**
- `id` int: A unique identifier for the player webpage
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Body**
- An array of [Permission](docId\:JWfyMC42cdRG5jY2SkYsU) entities
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Example**
The example request parameters and headers are set as follows:
- `id` is set to `646879`
```text
POST /2022/06/REST/DeviceWebPages/646879/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: 316
```
This is the example request body:
```json
[
{
"entityId": 546701,
"operationUID": "5c6ef943-d660-4907-aa56-e91903ff1772",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 0
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-11T18:46:30.1Z"
}
]
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Success Response**
204: The specified permissions were successfully granted
**Failure Response**
400: The request or request body is malformed and therefore invalid, or it is rejected in accordance to 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}/Permissions/
Removes permissions from a player webpage
**Required Scope Token**
bsn.api.main.devicewebpages.update
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segment**
- `id` int: A unique identifier for the player webpage
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Body**
- An array of [Permission](docId\:JWfyMC42cdRG5jY2SkYsU) entities
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Example**
The example request parameters and headers are set as follows:
- `id` is set to `646879`
```text
DELETE /2022/06/REST/DeviceWebPages/646879/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: 316
```
This is the example request body:
```json
[
{
"entityId": 546701,
"operationUID": "5c6ef943-d660-4907-aa56-e91903ff1772",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 0
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-11T18:46:30.1Z"
}
]
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Success Response**
204: The specified permissions were successfully deleted from the player webpage
**Failure Response**
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 to 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 player webpage instance.
**Required Scope Token**
bsn.api.main.devicewebpages.retrieve
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segment**
- `name` string: The name of the player webpage
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Example**
The example request parameters and headers are set as follows:
- `name` is set to `Default_PresentationWebPage`
```text
GET /2022/06/REST/DeviceWebPages/Default_PresentationWebPage/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
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Success Response Body**
200: Returns an array of [Permission](docId\:JWfyMC42cdRG5jY2SkYsU) entities
**Example**
```json
[
{
"entityId": 546701,
"operationUID": "5c6ef943-d660-4907-aa56-e91903ff1772",
"principal": {
"login": "JaneDoe@brightsign.biZ",
"type": "User",
"id": 102359
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-11T18:46:30.1Z"
}
]
```
**Failure Response**
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 for a player webpage
**Required Scope Token**
bsn.api.main.devicewebpages.update
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segment**
- `name` string: The name of the player webpage
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Body**
- An array of [Permission](docId\:JWfyMC42cdRG5jY2SkYsU) entities
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Example**
The example request parameters and headers are set as follows:
- `name` is set to `Default_PresentationWebPage`
```text
POST /2022/06/REST/DeviceWebPages/Default_PresentationWebPage/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: 316
```
This is the example request body:
```json
[
{
"entityId": 546701,
"operationUID": "5c6ef943-d660-4907-aa56-e91903ff1772",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 0
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-11T18:46:30.1Z"
}
]
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Success Response**
204: The specified permissions were successfully granted
**Failure Response**
400: The request or request body is malformed and therefore invalid, or it is rejected in accordance to 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 /\{name}/Permissions/
Removes permissions from a player webpage
**Required Scope Token**
bsn.api.main.devicewebpages.update
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segment**
- `name` string: The name of the player webpage
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Body**
- An array of [Permission](docId\:JWfyMC42cdRG5jY2SkYsU) entities
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Request Example**
The example request parameters and headers are set as follows:
- `name` is set to `Default_PresentationWebPage`
```text
DELETE /2022/06/REST/DeviceWebPages/Default_PresentationWebPage/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: 316
```
This is the example request body:
```json
[
{
"entityId": 546701,
"operationUID": "5c6ef943-d660-4907-aa56-e91903ff1772",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 0
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-11T18:46:30.1Z"
}
]
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Success Response**
204: The specified permissions were successfully deleted from the player webpage
**Failure Response**
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 to 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