Puntos finales de dispositivos (2022/06)
Este endpoint permite la administración y supervisión de reproductores en la red.
URL base para estos endpoints: https://api.bsn.cloud/2022/06/REST/Devices
_________________________________________________________________________
GET /
Recupera una lista de reproductores en la red.
Token de Scope requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Parámetros de Query String
- filtro string opcional: Una expresiónexpression para filtrar resultados de búsqueda. El valor predeterminado es null.
- ordenar string opcional: Una expresión para ordenar los resultados de búsqueda. La expresión de ordenación especifica la entrada usada para ordenar y el orden de clasificación ascendente/descendente (ASC/DESC) (p. ej., "[Device].[Serial] ASC").
- marcador string opcional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada isTruncated en el cuerpo de respuesta de la llamada GET anterior indica que el número de instancias de reproductor excede el pageSize. Este parámetro solo es requerido si necesita más elementos en la lista paginada que el pageSize (100).
- pageSize int opcionalEl número máximo de instancias de reproductor que pueden incluirse en el cuerpo de respuesta. De forma predeterminada, este valor es el tamaño máximo de página permitido (100).
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- marcador tiene como valor la propiedad [PagedList].[NextMarker] de la respuesta anterior de la API de BSN.Cloud.
- pageSize tiene como valor 1
- filtro tiene como valor [Model] IS 'HD1024'
- ordenar tiene como valor [LastModifiedDate] ASC
GET /2022/06/REST/Devices/?marker=Mj0kwMTU2&pageSize=1&filter=%5BModel%5D%20IS%20%27HD1024%27&sort=%5BLastModifiedDate%5D%20ASC 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______________________________________________________________
Cuerpo de respuesta exitosa
200: Devuelve una lista paginadapaged list de instancias de Entidad de reproductorPlayer Entity en una red. Esto devolverá no más de 100 entidades junto con la información necesaria para devolver cualquier otra página restante.
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /
Elimina jugadores, especificados mediante un filtro, de una red. Esto permite eliminar varios jugadores a la vez.
Token de Scope requerido
bsn.api.main.devices.delete
______________________________________________________________
Parámetro de cadena de consulta
- filtro string required: Una expresiónexpresión para filtrar resultados de búsqueda.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- filtro se establece en [Model] IS 'HD1024'
DELETE /2022/06/REST/Devices/?filter=%5BModel%5D%20IS%20%27HD1024%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______________________________________________________________
Cuerpo de respuesta exitosa
200: Devuelve el número de jugadores afectados como un valor entero.
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud están mal formados y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /Regions/{*locationPath}/
Devuelve una región que contiene todos los jugadores ubicados en la ruta especificada.
Token de Scope requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- locationPath string: Las partes de la ruta de ubicación del jugador devuelta (país, provincia, ciudad, etc.) que son comunes a todos los jugadores.
______________________________________________________________
Parámetro de cadena de consulta
- filtro string opcional: Una expresiónexpresión para filtrar resultados de búsqueda
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- filtro se establece en [Model] IS 'HD1024'
- locationPath se establece en /US/
GET /2022/06/REST/Devices/Regions/US/?filter=%5BModel%5D%20IS%20%27HD1024%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______________________________________________________________
Cuerpo de respuesta exitosa
200: Devuelve la Entidad de región de reproductor
Ejemplo
[
{
"country": "US",
"countryLongName": "United States",
"adminAreaLevel1": "MO",
"adminAreaLevel1LongName": "Missouri",
"adminAreaLevel2": "Callaway County",
"adminAreaLevel2LongName": "Callaway County",
"locality": "Fulton",
"localityLongName": "Fulton",
"minGPSLatitude": 38.8513,
"maxGPSLatitude": 38.8513,
"minGPSLongitude": -91.9604,
"maxGPSLongitude": -91.9604,
"devicesCount": 1,
"devicesHealthStatus": [
"Normal"
],
"locationPath": "/US/MO/Callaway County/Fulton/"
}
]Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /Count/
Recupera el número de reproductores en la red que coinciden con los criterios de filtro especificados. Si no se incluye ningún filtro, esta llamada devuelve el número total de reproductores en la red.
Token de alcance requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Parámetro de cadena de consulta
- filtro string opcional: Una expresiónexpresión para filtrar resultados de búsqueda.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- filtro se establece en [Model] IS 'HD1024'
GET /2022/06/REST/Devices/Count/?filter=%5BModel%5D%20IS%20%27HD1024%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______________________________________________________________
Respuesta correcta
200: La cantidad de reproductores se devuelve como un valor entero.
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{id}/
Devuelve la información de un reproductor especificado
Token de scope requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- id int: Un identificador único para el reproductor
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
- El valor opcional del encabezado If-Modified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta anterior de GET /id o GET /serial
GET /2022/06/REST/Devices/12345/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 13 Mar 2024 15:51:01 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta correcta con cuerpo
200: Devuelve la Entidad del reproductorPlayer Entity
Respuesta exitosa
304: El recurso no fue modificado desde la hora especificada en el encabezado “If-Modified-Since”
Respuesta de error
300: No se pudo devolver la representación solicitada porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no fue especificado
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
PUT /{id}/
Actualiza el reproductor especificado. Se aplica solo a la configuración del reproductor.
Token de alcance requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- id int: Un identificador único para el reproductor
______________________________________________________________
Cuerpo de la solicitud
- La Entidad del reproductorPlayer Entity
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
- El valor opcional del encabezado If-Unmodified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta de GET /id o GET /serial.
PUT /2022/06/REST/Devices/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, 13 Mar 2024 15:51:01 GMT
Content-Type: application/json
Content-Length: 5947Respuesta correcta
204: El reproductor especificado se actualizó correctamente
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud está mal formado y, por lo tanto, no es válido, o se rechaza de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
412: La condición previa falló (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
415: El servidor no puede aceptar la representación de datos que envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
PATCH /{id}/
Reemplaza ciertos parámetros en el reproductor especificado. Se aplica solo a la configuración del reproductor. Consulte rfc6902.
Token de alcance requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- id int: Un identificador único para el reproductor
______________________________________________________________
Cuerpo de la solicitud
Estas propiedades son entradas en un arreglo. Cada entrada debe tener estas tres propiedades:
- op string: El tipo de operación; en este caso siempre es "replace"
- ruta string: Una ruta Uri que hace referencia a la ubicación dentro del documento de destino donde se realizará la actualización
- valor object: Los valores de reemplazo para los parámetros que deben actualizarse
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id es 12345
- El valor opcional del encabezado If-Unmodified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta de GET /id o GET /serial.
PATCH /2022/06/REST/Devices/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, 13 Mar 2024 15:51:01 GMT
Content-Type: application/json-patch+json
Content-Length: 94Este es el cuerpo de la solicitud de ejemplo:
[
{
"op": "replace",
"path": "/settings/description/",
"value": "Main Screen Player"
}
]______________________________________________________________
Respuesta correcta
204: Los parámetros se reemplazaron correctamente.
Respuesta de error
400: La solicitud o el cuerpo de la solicitud está mal formado y, por lo tanto, no es válido, o es rechazado de acuerdo con las reglas de negocio
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
412: Error de condición previa (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
415: El servidor no puede aceptar la representación de datos que envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{id}/
Elimine el reproductor especificado
Token de alcance requerido
bsn.api.main.devices.delete
______________________________________________________________
Segmento
- id int: Un identificador único para el reproductor que se eliminará
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
- El valor opcional del encabezado If-Unmodified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta GET /id o GET /serial .
DELETE /2022/06/REST/Devices/12345/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}}
If-Unmodified-Since: Wed, 13 Mar 2024 15:51:01 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta correcta
204: El reproductor se eliminó correctamente
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tiene un formato incorrecto y, por lo tanto, no es válido, o se rechaza de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
412: La condición previa falló (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
5XX: Cualquier código 500 es un error interno del servidor
GET /{serial}/
Devuelve la información del reproductor especificado
Scope requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- serie se establece en 46D89C101139
- El valor opcional del encabezado If-Modified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta anterior GET /id o GET /serial
GET /2022/06/REST/Devices/46D89C101139/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 13 Mar 2024 15:51:01 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta correcta con cuerpo
200: Devuelve la Entidad de reproductorPlayer Entity
Respuesta correcta
304: El recurso no se modificó desde el momento especificado en el encabezado “If-Modified-Since”
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
PUT /{serial}/
Actualiza un reproductor especificado. Se aplica solo a la configuración del reproductor.
Token de alcance requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
______________________________________________________________
Cuerpo de la solicitud
- La Entidad del reproductorPlayer Entity
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- serie se establece en 46D89C107131
- El valor opcional del encabezado If-Unmodified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta de GET /id o GET /serial.
PUT /2022/06/REST/Devices/46D89C107131/ 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, 13 Mar 2024 15:51:01 GMT
Content-Type: application/json
Content-Length: 5947Este es el cuerpo de la solicitud de ejemplo:
{
"id": 0,
"serial": "46D89C107131",
"model": "HD1024",
"family": "Pagani",
"registrationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"settings": {
"name": "OutsidePlayer",
"description": "Outside of Building A",
"concatNameAndSerial": false,
"setupType": "BSN",
"lastModifiedDate": "2022-01-05T18:12:22.643Z",
"group": {
"id": 123,
"name": "TestGroup",
"link": null
},
"brightWall": null,
"timezone": "PST",
"screen": {
"idleColor": "FF702896",
"splashUrl": null
},
"synchronization": {
"status": {"period": "00:05:00"},
"settings": {"period": "00:00:00"},
"schedule": {"period": "06:00:00"},
"content": {
"start": null,
"end": null
}
},
"network": {
"hostname": "BrightSign-46D89C107131",
"proxyServer": null,
"proxyBypass": [],
"timeServers": ["http://time.brightsignnetwork.com/"],
"interfaces": [
{
"enabled": true,
"proto": "DHCP",
"ip": null,
"gateway": null,
"dns": null,
"rateLimitDuringInitialDownloads": 0,
"rateLimitInsideContentDownloadWindow": 0,
"rateLimitOutsideContentDownloadWindow": null,
"contentDownloadEnabled": true,
"textFeedsDownloadEnabled": true,
"mediaFeedsDownloadEnabled": true,
"healthReportingEnabled": true,
"logsUploadEnabled": true,
"name": "eth0",
"type": "Ethernet"
},
{
"enabled": false,
"ssid": "",
"security": {
"authentication": {
"mode": "Shared",
"passphrase": ""
},
"encryption": {"mode": "TKIP, CCMP"}
},
"proto": "DHCP",
"ip": null,
"gateway": null,
"dns": null,
"rateLimitDuringInitialDownloads": 0,
"rateLimitInsideContentDownloadWindow": 0,
"rateLimitOutsideContentDownloadWindow": 0,
"contentDownloadEnabled": false,
"textFeedsDownloadEnabled": false,
"mediaFeedsDownloadEnabled": false,
"healthReportingEnabled": false,
"logsUploadEnabled": false,
"name": "wlan0",
"type": "WiFi"
}
]
},
"beacons": [],
"location": null,
"screenshots": null,
"logging": {
"enableDiagnosticLog": false,
"enableEventLog": false,
"enablePlaybackLog": false,
"enableStateLog": false,
"enableVariableLog": false,
"uploadAtBoot": false,
"uploadTime": null
},
"lws": {
"username": "",
"password": "",
"enableUpdateNotifications": true
},
"ldws": {"password": "RLSJPQSm9z15lB8nwVFWjkPYegscBlMF3NFG6wt3aSTXIoC+iR5NGrhJa77ZaWTgpiCzPdDdnwMlQSb4QLqe6nEFx6q/927scO6LlVTtRBVch+RlgzlJ2SXYqAH6TUx66JRFuvCxyHzL0iUNKR/R4E1hdTQpxH3yXIPJ5OBOTlaw8OW6DZNixDGMuvhgmWAW9/TgksUYTlwb1SKqGzQOrDYmmg+A71YMGV6NcKbuN3P0DjQsMrVxlFe9+awQ73LSxqKF5Q52FjUhgSKsYcTtnoJvY/n9HWcREyxOPKF7vsEIfKOeG/qoFBvgZZKOoqaTyD82iBKbOQu9WllBGX+qaaTTQHR1SrZoyS2PDmBlddLhngE4BHiDxmOPhm69bsmiakUcUqgjvgi8sRL/9kUxLXuayeQ6VYzUnHdX7K3nYqbhgJCxVbSURe5wIS/vQ97zi4wt0NpF55FmoAQlZA1JcSk/85w8S4hfpCYlDnqQMI8jXqvNZ5apc7nKsg6NSibGhh4h1cpA7DG6d6MzjBldVKhutni3Bj991cP45RIaGlmWipbC9eKwODrsDPYMK2CDN/JEygmfiUdJJW4Cvgi4s6Z3oyqddiEV+plZtGD69NAau4OMCoHcR1STJdsVOrq++tF+R0/IkC5wDhAUBszXvlSdcKja7Gv7v4kOAZC0CmtA="}
},
"status": null,
"subscription": null,
"taggedGroups": [],
"tags": {},
"permissions": []
}______________________________________________________________
Respuesta correcta
204: El reproductor especificado se actualizó correctamente
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
412: Error de condición previa (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
415: El servidor no puede aceptar la representación de datos que usted envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
PATCH /{serial}/
Reemplaza ciertos parámetros en el reproductor especificado. Se aplica solo a la configuración del reproductor. Consulte rfc6902.
Token de alcance requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor que se eliminará
______________________________________________________________
Cuerpo de la solicitud
Estas propiedades son entradas en una matriz. Cada entrada debe tener estas tres propiedades:
- op string: El tipo de operación; en este caso siempre es "replace"
- ruta string: Una ruta Uri que hace referencia a la ubicación dentro del documento de destino donde se realizará la actualización
- valor object: Los valores de reemplazo para los parámetros que deben actualizarse.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- serie es 46D89C101139
- El valor opcional del encabezado If-Unmodified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta de GET /id o GET /serial.
PATCH /2022/06/REST/Devices/46D89C101139/ 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, 13 Mar 2024 15:51:01 GMT
Content-Type: application/json-patch+json
Content-Length: 94Este es el cuerpo de la solicitud de ejemplo:
[
{
"op": "replace",
"path": "/settings/description/",
"value": "Main Screen Player"
}
]______________________________________________________________
Respuesta exitosa
204: Los parámetros se reemplazaron correctamente.
Respuesta de error
400: La solicitud o el cuerpo de la solicitud tiene un formato incorrecto y, por lo tanto, no es válido, o se rechaza de acuerdo con las reglas de negocio
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
412: La condición previa falló (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
415: El servidor no puede aceptar la representación de datos que usted envió (según se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{serial}/
Elimine el reproductor especificado
Token de alcance requerido
bsn.api.main.devices.delete
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- serie se establece en 46D89C101139
- El valor opcional del encabezado If-Unmodified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta GET /id o GET /serial.
DELETE /2022/06/REST/Devices/46D89C101139/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}}
If-Unmodified-Since: Wed, 13 Mar 2024 15:51:01 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta correcta
204: El reproductor se eliminó correctamente
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
412: La condición previa falló (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
5XX: Cualquier código 500 es un error interno del servidor
GET /{deviceId}/Beacons/
Devuelve la matriz de todos los beacons definidos para el reproductor especificado
Token de Scope requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- deviceId int: Un identificador único para la instancia del reproductor
______________________________________________________________
Cuerpo de la respuesta correcta
200: La colección de Entidades Beacon del reproductorPlayer Beacon Entities
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{serial}/Beacons/
Devuelve el arreglo de todas las balizas definidas para el reproductor especificado
Token de Scope requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- serie string: El número de serie de la instancia del reproductor
______________________________________________________________
Cuerpo de la respuesta exitosa
200: La colección de Entidades de baliza del reproductorPlayer Beacon Entities
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{deviceId}/Beacons/{name}/
Devuelve una baliza de dispositivo de cierto tipo asociada con un reproductor especificado y el nombre especificado
Token de Scope requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- deviceId int: Un identificador único para la instancia del reproductor
- nombre string: El nombre de la baliza del reproductor
______________________________________________________________
Cuerpo de la respuesta exitosa
200: Devuelve la Entidad de baliza del reproductorPlayer Beacon Entity
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{deviceId}/Beacons/{name}/
Elimina una beacon de reproductor especificada de un reproductor especificado.
Token de alcance requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- deviceId int: Un identificador único para la instancia del reproductor
- nombre string: El nombre de la beacon del reproductor
______________________________________________________________
Respuesta exitosa
204: La beacon del reproductor especificada se eliminó correctamente del reproductor
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tiene un formato incorrecto y, por lo tanto, es inválido, o se rechaza de acuerdo con las reglas de negocio
401: El token de acceso es inválido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{serial}/Beacons/{name}/
Devuelve una beacon de reproductor de un determinado tipo asociada con un reproductor especificado y el nombre especificado
Token de alcance requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
- nombre string: El nombre del reproductor
______________________________________________________________
Cuerpo de respuesta exitosa
200: Devuelve la Entidad de beacon del reproductorEntidad de beacon del reproductor
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, es inválida
401: El token de acceso es inválido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{serial}/Beacons/{name}/
Elimina un beacon de reproductor especificado en un reproductor especificado.
Token de Scope requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
- nombre string: El nombre del beacon que se va a eliminar
______________________________________________________________
Respuesta exitosa
204: El beacon de reproductor especificado se eliminó correctamente del reproductor
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud están mal formados y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /{id}/Beacons/
Crea un beacon de reproductor
Token de Scope requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- id int: Un identificador único para la instancia del reproductor en la que usted desea crear el beacon
______________________________________________________________
Cuerpo de la solicitud
- La Entidad de beacon de reproductorPlayer Beacon Entity
______________________________________________________________
Cuerpo de respuesta exitosa
201: Devuelve el nuevo recurso creado y referenciado por el Uri (proporcionado por el campo de encabezado Location) en la respuesta. La respuesta incluye la Entidad de beacon de reproductorPlayer Beacon Entity.
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud están mal formados y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
415: El servidor no puede aceptar la representación de datos que envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
POST /{serial}/Beacons/
Crea un beacon de reproductor en un reproductor especificado.
Token de Scope requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor en el que desea crear el beacon
______________________________________________________________
Cuerpo de la solicitud
- La Entidad de Beacon de ReproductorPlayer Beacon Entity
______________________________________________________________
Cuerpo de respuesta exitosa
201: Devuelve el nuevo recurso creado y referenciado por el Uri (proporcionado por el campo de encabezado Location) en la respuesta. La respuesta incluye la Entidad de Beacon de ReproductorPlayer Beacon Entity.
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud están mal formados y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
415: El servidor no puede aceptar la representación de datos que envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
GET /{id}/Errors/
Devuelve una lista de errores asociados con un reproductor especificado
Token de Scope requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- id int: Un identificador único para el reproductor que informa los errores
______________________________________________________________
Parámetros de cadena de consulta
- marcador string opcional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada isTruncated en el cuerpo de la respuesta de la llamada GET anterior indica que el número de instancias de error supera el valor de pageSize. Este parámetro solo es obligatorio si necesita más elementos en la lista paginada que el valor de pageSize (100).
- pageSize int opcional: El número máximo de instancias de error que pueden incluirse en el cuerpo de la respuesta.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
- marcador se establece en el valor de propiedad [PagedList].[NextMarker] de la respuesta anterior de la API de BSN.Cloud.
- pageSize se establece en 1
GET /2022/06/REST/Devices/12345/Errors/?pageSize=1&marker=a9DH34d23Bh0 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______________________________________________________________
Cuerpo de respuesta correcta
200: Devuelve la Entidad de error del reproductorPlayer Error Entity
Ejemplo
{
"items": [
{
"timestamp": "2023-03-21T20:36:21.887Z",
"errorName": "Failed to download sync list",
"errorEvent": "deviceError",
"reason": "Connection timed out after 30000 milliseconds",
"responseCode": -28
}
],
"totalItemCount": 9,
"matchingItemCount": 9,
"pageSize": 1,
"nextMarker": "9DH34d23Bc1fjkdsa",
"prevMarker": "9DH34d23Bc1fj786t",
"isTruncated": false,
"sortExpression": "[DeviceError].[Timestamp] DESC",
"filterExpression": null
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay varias representaciones solicitadas)
400: La solicitud está mal formada y, por tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{serial}/Errors/
Devuelve una lista de errores asociados con un reproductor especificado
Token de alcance requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor que informa los errores
______________________________________________________________
Parámetros de Query String
- marcador string opcional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada isTruncated en el cuerpo de respuesta de la llamada GET anterior indica que el número de instancias de error excede el valor de pageSize. Este parámetro solo es obligatorio si necesita más elementos en la lista paginada que el valor de pageSize (100).
- pageSize int opcional: El número máximo de instancias de error que pueden estar contenidas en el cuerpo de respuesta
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- serie se establece en 46D89C101139
- marcador se establece en el valor de la propiedad [PagedList].[NextMarker] de la respuesta anterior de la API BSN.Cloud.
- pageSize se establece en 1
GET /2022/06/REST/Devices/46D89C101139/Errors/?pageSize=1&marker=Vsh54Uh9Mn0s 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______________________________________________________________
Cuerpo de respuesta exitosa
200: Devuelve la Entidad de error del reproductorEntidad de error del reproductor
Ejemplo
{
"items": [
{
"timestamp": "2023-03-21T20:36:21.887Z",
"errorName": "Failed to download sync list",
"errorEvent": "deviceError",
"reason": "Connection timed out after 30000 milliseconds",
"responseCode": -28
}
],
"totalItemCount": 9,
"matchingItemCount": 9,
"pageSize": 1,
"nextMarker": "34DH04d23c00JK",
"prevMarker": "34DH04d23cfhg9",
"isTruncated": false,
"sortExpression": "[DeviceError].[Timestamp] DESC",
"filterExpression": null
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{id}/Downloads/
Devuelve las descargas asociadas con un reproductor especificado
Token de alcance requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- id int: El identificador único del reproductor que tiene las instancias de descarga
______________________________________________________________
Parámetros de Query String
- marcador string opcional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada isTruncated en el cuerpo de la respuesta de la llamada GET anterior indica que el número de instancias de descarga excede el valor de pageSize. Este parámetro solo es necesario si necesita más elementos en la lista paginada que el valor de pageSize (100).
- pageSize int opcional: El número máximo de instancias de descarga que pueden estar contenidas en el cuerpo de la respuesta
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
- marcador se establece en el valor de la propiedad [PagedList].[NextMarker] de la respuesta anterior de la API de BSN.Cloud.
- pageSize se establece en 3
GET /2022/06/REST/Devices/12345/Downloads/?pageSize=3&marker=BN548plV2hZW4tWW HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json, application/*
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de la respuesta exitosa
200: Devuelve la Entidad de descarga del reproductorPlayer Download Entity
Ejemplo
{
"items": [
{
"timestamp": "2021-05-04T17:44:06.533Z",
"fileName": "ZoomBG.jpeg",
"fileHash": "SHA1:311822ED6A306CB3F2775CB3D9FF1A8C96680E92",
"progress": 42,
"status": "downloading"
},
{
"timestamp": "2021-05-04T17:44:06.533Z",
"fileName": "featureMinRevs.json",
"fileHash": "SHA1:98E4C18E11C4D41D5742756213C103B671B985E9",
"progress": 100,
"status": "ok"
},
{
"timestamp": "2021-05-04T17:44:06.533Z",
"fileName": "autoplugins.brs",
"fileHash": "SHA1:A0ACB3E76C85E48D326E802428B23F1325667410",
"progress": 100,
"status": "ok"
}
],
"totalItemCount": 7,
"matchingItemCount": 7,
"pageSize": 3,
"nextMarker": "HFfakds789nm06",
"prevMarker": "HFfakds789/0nm",
"isTruncated": true,
"sortExpression": "[DeviceDownload].[Timestamp] DESC",
"filterExpression": null
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está malformada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se ha especificado
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{serial}/Downloads/
Devuelve una lista de descargas realizadas por un reproductor (especificado por número de serie).
Token de Scope requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor que tiene las instancias de descarga
______________________________________________________________
Parámetros de Query String
- marcador string opcional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada isTruncated del cuerpo de respuesta de la llamada GET anterior indica que el número de instancias de descarga supera el valor de pageSize. Este parámetro solo es necesario si necesita más elementos en la lista paginada que el valor de pageSize (100).
- pageSize int opcional: El número máximo de instancias de descarga que pueden incluirse en el cuerpo de respuesta
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- serie se establece en 46D89C101139
- marcador se establece en el valor de la propiedad [PagedList].[NextMarker] de la respuesta anterior de la API BSN.Cloud.
- pageSize se establece en 3
GET /2022/06/REST/Devices/46D89C101139/Downloads/?pageSize=3&marker=W4tWW3hcnMsMTcyMU478ngh HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json, application/*
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de respuesta exitosa
200: Devuelve la Entidad de descarga del reproductorPlayer Download Entity
Ejemplo
{
"items": [
{
"timestamp": "2021-05-04T17:44:06.533Z",
"fileName": "ZoomBG.jpeg",
"fileHash": "SHA1:311822ED6A306CB3F2775CB3D9FF1A8C96680E92",
"progress": 42,
"status": "downloading"
},
{
"timestamp": "2021-05-04T17:44:06.533Z",
"fileName": "featureMinRevs.json",
"fileHash": "SHA1:98E4C18E11C4D41D5742756213C103B671B985E9",
"progress": 100,
"status": "ok"
},
{
"timestamp": "2021-05-04T17:44:06.533Z",
"fileName": "autoplugins.brs",
"fileHash": "SHA1:A0ACB3E76C85E48D326E802428B23F1325667410",
"progress": 100,
"status": "ok"
}
],
"totalItemCount": 7,
"matchingItemCount": 7,
"pageSize": 3,
"nextMarker": "fjdkah890vdjk",
"prevMarker": "fjdkah890546k",
"isTruncated": true,
"sortExpression": "[DeviceDownload].[Timestamp] DESC",
"filterExpression": null
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{deviceid}/ScreenShots/
Devuelve una lista de capturas de pantalla cargadas por un reproductor especificado
Token de alcance requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- id int: El identificador único del reproductor
______________________________________________________________
Parámetros de cadena de consulta
- marcador string opcional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada isTruncated en el cuerpo de respuesta de la llamada GET anterior indica que el número de instancias de capturas de pantalla excede el pageSize. Este parámetro solo es obligatorio si necesita más elementos en la lista paginada que el pageSize (100).
- pageSize int opcional: El número máximo de instancias de capturas de pantalla que pueden incluirse en el cuerpo de respuesta
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 1234567
- marcador se establece en el valor de propiedad [PagedList].[NextMarker] de la respuesta anterior de la API BSN.Cloud.
- pageSize se establece en 1
GET /2022/06/REST/Devices/1234567/ScreenShots/?marker=SE4ODYzNF230OTv&pageSize=1 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______________________________________________________________
Cuerpo de respuesta exitosa
200: Devuelve la Entidad ScreenShot .
Ejemplo
{
"items": [
{
"id": 12345,
"device": {
"id": 1234567,
"serial": "CFD02W901738"
},
"groupName": "Default",
"presentationName": "videos-and-images",
"utcTimestamp": "2023-10-19T15:07:57Z",
"localTimestamp": "2023-10-19T10:07:57",
"width": 1920,
"height": 1080,
"filePath": "https://bsncloud-dssp.s3.amazonaws.com/DeviceScreenShots/Public/CFD02W901738/2023-10-19T15-07-57.7710000Z.jpg",
"fileSize": 802681,
"thumbPath": "https://bsncloud-dssp.s3.amazonaws.com/DeviceScreenShots/Public/CFD02W901738/2023-10-19T15-07-57.7710000Z.thumb.150x150.jpg"
}
],
"totalItemCount": 4,
"matchingItemCount": 4,
"pageSize": 1,
"nextMarker": "LDE4ODYzNTI0OTU=",
"prevMarker": "LDE4ODYzNTI0h893",
"isTruncated": true,
"sortExpression": "[DeviceScreenShot].[UTCTimestamp] DESC",
"filterExpression": null
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{serial}/ScreenShots/
Devuelve una lista de capturas de pantalla cargadas por un reproductor especificado
Token de alcance requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
______________________________________________________________
Parámetros de cadena de consulta
- marcador string opcional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada isTruncated en el cuerpo de respuesta de la llamada GET anterior indica que el número de instancias de capturas de pantalla supera el pageSize. Este parámetro solo es necesario si usted necesita más elementos en la lista paginada que el pageSize (100).
- pageSize int opcional: El número máximo de instancias de capturas de pantalla que pueden incluirse en el cuerpo de respuesta
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- serie se establece en CFD02W901738
- marcador se establece en el valor de la propiedad [PagedList].[NextMarker] de la respuesta anterior de la API de BSN.Cloud.
- pageSize se establece en 1
GET /2022/06/REST/Devices/CFD02W901738/ScreenShots/?marker=G140faj35k8as&pageSize=1 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______________________________________________________________
Cuerpo de respuesta exitosa
200: Devuelve la Entidad ScreenShot
Ejemplo
{
"items": [
{
"id": 12345,
"device": {
"id": 1234567,
"serial": "CFD02W901738"
},
"groupName": "Default",
"presentationName": "videos-and-images",
"utcTimestamp": "2023-10-19T15:07:57Z",
"localTimestamp": "2023-10-19T10:07:57",
"width": 1920,
"height": 1080,
"filePath": "https://bsncloud-dssp.s3.amazonaws.com/DeviceScreenShots/Public/CFD02W901738/2023-10-19T15-07-57.7710000Z.jpg",
"fileSize": 802681,
"thumbPath": "https://bsncloud-dssp.s3.amazonaws.com/DeviceScreenShots/Public/CFD02W901738/2023-10-19T15-07-57.7710000Z.thumb.150x150.jpg"
}
],
"totalItemCount": 4,
"matchingItemCount": 4,
"pageSize": 1,
"nextMarker": "GH0dkf78aok34",
"prevMarker": "GH0dkf78a5783",
"isTruncated": true,
"sortExpression": "[DeviceScreenShot].[UTCTimestamp] DESC",
"filterExpression": null
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /ScreenShots/
Devuelve una lista de capturas de pantalla cargadas por un reproductor
Token de alcance requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Parámetros de Query String
- proyección string opcional: Este parámetro actualmente admite solo un marcador de posición (TOP({int},[Nodes])]) que limita el número de entidades en un grupo. El valor posible para {int} es cualquier número del 1 al 100.
- filtro string opcional: Una expresiónexpresión para filtrar resultados de búsqueda
- agrupación string opcional: Una expresión de agrupación para las entidades filtradas. Este parámetro puede utilizarse con el parámetro proyección para recuperar una determinada cantidad de capturas de pantalla para una gran cantidad de dispositivos en una sola solicitud (por ejemplo, 100 capturas de pantalla de 100 reproductores).
- ordenar string opcional: Una expresión para ordenar los resultados de búsqueda. La expresión de ordenación especifica la entrada usada para ordenar y el orden de clasificación ascendente/descendente (ASC/DESC) (p. ej., "[Device].[Serial] ASC")
- marcador string opcional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada isTruncated en el cuerpo de respuesta de la llamada GET anterior indica que la cantidad de instancias de capturas de pantalla supera el pageSize. Este parámetro solo es necesario si usted necesita más elementos en la lista paginada que el pageSize (100).
- pageSize int opcional: La cantidad máxima de instancias de capturas de pantalla que puede contener el cuerpo de respuesta
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- proyección se establece en TOP(3,[Nodes])
- filtro se establece en [groupName] es 'Predeterminado'
- agrupación se establece en [Serial]
- ordenar se establece en [Id] ASC
- marcador se establece en el valor de la propiedad [PagedList].[NextMarker] de la respuesta anterior de la API de BSN.Cloud.
- pageSize se establece en 1
GET /2022/06/REST/Devices/ScreenShots/?marker=MTgzMDA1MTQ5MiwxODMwMDUxNDky&projection=TOP%283%2C%5BNodes%5D%29&pageSize=1&filter=%5BgroupName%5D%20IS%20%27Default%27&grouping=%5BSerial%5D&sort=%5BId%5D%20ASC HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json, application/*
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de respuesta exitoso
200: Devuelve la Entidad ScreenShot
Ejemplo
{
"items": [
{
"id": 1829566038,
"device": {
"id": 0123456,
"serial": "E9E8J5401510"
},
"groupName": "Default",
"presentationName": "videos-and-images",
"utcTimestamp": "2023-09-22T06:05:43Z",
"localTimestamp": "2023-09-22T01:05:43",
"width": 1920,
"height": 1080,
"filePath": "https://bsncloud-dssp.s3.amazonaws.com/DeviceScreenShots/Public/D9E8D5001519/2023-09-22T06-05-43.2670000Z.jpg",
"fileSize": 1169176,
"thumbPath": "https://bsncloud-dssp.s3.amazonaws.com/DeviceScreenShots/Public/D9E8D5001519/2023-09-22T06-05-43.2670000Z.thumb.150x150.jpg"
}
],
"totalItemCount": 1256,
"matchingItemCount": 19,
"pageSize": 1,
"nextMarker": "MTgyOTYwODM2NCwxODI5NjA4MzY0",
"prevMarker": "MTgyOTYwODM2NCwxODI5NjA478gh",
"isTruncated": true,
"sortExpression": "[Id] ASC",
"filterExpression": "[groupName] IS 'Default'"
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{id}/Tags/
Devuelve un objeto cuyos nombres de propiedad coinciden con las claves de etiqueta y cuyos valores de propiedad coinciden con los valores de etiqueta en un reproductor
Token de Scope requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- id int: El identificador único del reproductor
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
GET /2022/06/REST/Devices/12345/Tags/ 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______________________________________________________________
Cuerpo de respuesta exitosa
200: Una colección de pares clave-valor donde la clave es el nombre de la etiqueta y el valor es el valor de la etiqueta. Consulte la entrada Etiquetas en Entidad PlayerPlayer Entity para obtener más información.
Ejemplo
{"string::[Device].<Testing2>": "PlayAllDay"}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /{id}/Tags/
Agrega etiquetas a un reproductor especificado
Token de alcance requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- id int: El identificador único del reproductor
______________________________________________________________
Cuerpo de la solicitud
- etiquetas DynamicObject: Una colección de pares clave-valor donde la clave es el nombre de la etiqueta y el valor es el valor de la etiqueta. Consulte la entrada Etiquetas en Entidad del reproductorEntidad del reproductor para obtener más información.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
POST /2022/06/REST/Devices/12345/Tags/ 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: 73Este es el cuerpo de la solicitud de ejemplo:
{
"Number::[Device].<Number>":"1",
"Boolean::[Device].<Boolean>":true
}______________________________________________________________
Respuesta correcta
204: Las etiquetas se agregaron al reproductor especificado
Respuesta de error
400: Ya se había definido una etiqueta con la clave especificada, la solicitud tiene un formato incorrecto y por lo tanto no es válida, o existe un conflicto
401: El token de acceso es inválido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
415: El servidor no puede aceptar la representación de datos que envió (según se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{id}/Tags/
Elimina etiquetas de un reproductor especificado
Token de alcance requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- id int: El identificador único del reproductor
______________________________________________________________
Cuerpo de la solicitud
- lista string[]: Una matriz de claves de etiquetas para eliminar
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
DELETE /2022/06/REST/Devices/12345/Tags/ 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: 64Este es el cuerpo de la solicitud de ejemplo:
[
"Number::[Device].<Number>",
"Boolean::[Device].<Boolean>"
]______________________________________________________________
Respuesta correcta
204: La etiqueta especificada se eliminó correctamente del reproductor
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{serial}/Tags/
Devuelve un objeto cuyos nombres de propiedad coinciden con las claves de las etiquetas y cuyos valores de propiedad coinciden con los valores de las etiquetas en un reproductor
Token de alcance requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- serie se establece en 35F89C022150
GET /2022/06/REST/Devices/35F89C022150/Tags/ 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______________________________________________________________
Cuerpo de la respuesta correcta
200: Una colección de pares clave-valor donde la clave es el nombre de la etiqueta y el valor es el valor de la etiqueta. Consulte la entrada Etiquetas en Entidad del reproductorPlayer Entity para obtener más información.
Ejemplo
{"string::[Device].<Testing2>": "PlayAllDay"}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está malformada y por lo tanto no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /{serial}/Tags/
Agrega una o más etiquetas a un reproductor especificado
Token de Scope requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
______________________________________________________________
Cuerpo de la solicitud
- etiquetas DynamicObject: Una colección de pares clave-valor donde la clave es el nombre de la etiqueta y el valor es el valor de la etiqueta. Consulte la entrada Etiquetas en la Entidad del reproductorEntidad del reproductor para obtener más información.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- serie se establece en 35F89C022150
POST /2022/06/REST/Devices/35F89C022150/Tags/ 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: 73Este es el cuerpo de la solicitud de ejemplo:
{
"Number::[Device].<Number>":"1",
"Boolean::[Device].<Boolean>":true
}______________________________________________________________
Respuesta correcta
204: Las etiquetas se agregaron al reproductor especificado
Respuesta de error
400: Ya se había definido una etiqueta con la clave especificada, la solicitud está malformada y por lo tanto no es válida, o existe un conflicto
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
415: El servidor no puede aceptar la representación de datos que envió (según se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{serial}/Tags/
Elimina una o más etiquetas de un reproductor especificado
Token de Scope requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
______________________________________________________________
Cuerpo de la solicitud
- lista string[]: Una matriz de claves de etiquetas para eliminar
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- serie se establece en 35F89C022150
DELETE /2022/06/REST/Devices/35F89C022150/Tags/ 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: 64Este es el cuerpo de la solicitud de ejemplo:
[
"Number::[Device].<Number>",
"Boolean::[Device].<Boolean>"
]______________________________________________________________
Respuesta exitosa
204: La etiqueta especificada se eliminó correctamente del reproductor
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /Models/
Devuelve la lista de modelos de reproductor compatibles con la versión actual de Main API
Token de Scope requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
GET /2022/06/REST/Devices/Models/ 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______________________________________________________________
Cuerpo de respuesta exitosa
200: Devuelve la lista completa de modelos de reproductor compatibles con esta versión de Main API
Ejemplo
[
"HD223",
"HD1023",
"HD1423",
"LS423",
"XD233",
"XD1033",
"XD1133",
"XT243",
"XT1043",
"XT1143",
"4K242",
"4K1042",
"4K1142",
"HS123",
"HO523",
"XD234",
"XD1034",
"XT244",
"XT1144",
"HS124",
"HS144",
"LS424",
"HD224",
"HD1024",
"AU325",
"AU335",
"XC2055",
"XC4055",
"LS425",
"LS445",
"HS125",
"HS145",
"HD225",
"HD1025",
"XD235",
"XD1035",
"XT245",
"XT1145",
"XT2145"
]Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /Models/{model}/
Devuelve la lista de modelos de reproductor compatibles con la versión actual de Main API
Token de Scope requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- modelo string: El modelo del reproductor
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- modelo es XD1034
GET /2022/06/REST/Devices/Models/XD1034/ 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______________________________________________________________
Cuerpo de la respuesta exitosa
200: Devuelve la lista completa de modelos de reproductor compatibles con esta versión de Main API
Ejemplo
"XD1034"Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El modelo de reproductor proporcionado no existe (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /Models/{model}/Connectors/
Devuelve la lista de conectores disponibles en un modelo de reproductor determinado.
Token de Scope requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- modelo string: El modelo del reproductor
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- modelo se establece en XD1034
GET /2022/06/REST/Devices/Models/XD1034/Connectors/ 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______________________________________________________________
Cuerpo de respuesta exitosa
200: Devuelve la lista de conectores disponibles en un modelo de reproductor determinado
Ejemplo
["HDMI"]Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El modelo de reproductor proporcionado no existe o es incorrecto
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /Models/{model}/Connectors/{connector}/
Devuelve la lista de conectores disponibles en un modelo de reproductor determinado
Token de alcance requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- modelo string: El modelo del reproductor
- conector string:El conector de video (por ejemplo, "HDMI" o "DisplayPort")
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- modelo se establece en XD1034
- conector se establece en HDMI
GET /2022/06/REST/Devices/Models/XD1034/Connectors/HDMI/ 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______________________________________________________________
Cuerpo de respuesta exitosa
200: Devuelve la lista de conectores disponibles en un modelo de reproductor determinado
Ejemplo
"HDMI"Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El modelo de reproductor o conector proporcionado no existe o es incorrecto
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /Models/{model}/Connectors/{connector}/VideoModes/
Devuelve los Modos de video compatibles con el conector especificado en el modelo de reproductor especificado.
Token de alcance requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- modelo string: El modelo del reproductor
- conector string: El conector de video (por ejemplo, "HDMI" o "DisplayPort")
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- modelo se establece en XD1034
- conector se establece en HDMI
GET /2022/06/REST/Devices/Models/XD1034/Connectors/HDMI/VideoModes/ 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______________________________________________________________
Cuerpo de la respuesta correcta
200: El cuerpo de la respuesta es una matriz de cadenas que enumera los Modos de video compatibles con el conector especificado en el modelo de reproductor especificado.
Ejemplo
[
"4096x2160x23.976p",
"4096x2160x24p",
"4096x2160x25p",
"4096x2160x29.97p",
"4096x2160x30p",
"4096x2160x50p",
"4096x2160x59.94p",
"4096x2160x60p",
"3840x2160x60p",
"3840x2160x59.94p",
"3840x2160x50p",
"3840x2160x30p",
"3840x2160x29.97p",
"3840x2160x25p",
"3840x2160x24p",
"3840x2160x23.976p",
"3840x1080x60p",
"3840x1080x50p",
"3840x1080x30p",
"3840x1080x25p",
"3840x600x60p",
"3440x1440x60p",
"3440x1440x50p",
"3440x1440x30p",
"2560x1600x60p",
"2560x1440x60p",
"2560x1440x30p",
"2560x1080x60p",
"2560x960x60p",
"2048x1152x60p",
"1920x1920x60p",
"1920x1200x60p",
"1920x1200x50p",
"1920x1080x60p",
"1920x1080x59.94p",
"1920x1080x50p",
"1920x1080x30p",
"1920x1080x29.97p",
"1920x1080x25p",
"1920x1080x24p",
"1920x1080x23.976p",
"1920x1080x60i",
"1920x1080x59.94i",
"1920x1080x50i",
"1920x540x60p",
"1680x1050x60p",
"1600x1200x60p",
"1600x900x60p",
"1440x1080x60p",
"1440x900x75p",
"1440x900x60p",
"1400x1050x75p",
"1400x1050x60p",
"1366x768x60p",
"1360x768x60p",
"1280x1024x75p",
"1280x1024x60p",
"1280x960x60p",
"1280x800x75p",
"1280x800x60p",
"1280x768x60p",
"1280x720x60p",
"1280x720x59.94p",
"1280x720x50p",
"1280x720x25p",
"1280x720x24p",
"1280x720x23.976p",
"1200x1920x60p",
"1024x768x75p",
"1024x768x60p",
"960x960x60p",
"800x1280x60p",
"800x600x75p",
"800x600x60p",
"720x576x50p",
"720x576x50i",
"720x480x60p",
"720x480x60i",
"720x480x59.94p",
"640x480x60p"
]Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El modelo de reproductor o conector proporcionado no existe o es incorrecto
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /Operations/
Devuelve permisos operativos otorgados a los roles para operaciones comerciales específicas
Token de alcance requerido
bsn.api.main.operations.retrieve
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
GET /2022/06/REST/Devices/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______________________________________________________________
Cuerpo de la respuesta correcta
200: Devuelve la Entidad de operaciones comercialesBusiness Operations Entity
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está malformada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{id}/Permissions/
Devuelve la lista de permisos que permiten o deniegan la ejecución de operaciones comerciales específicas en el reproductor especificado
Token de alcance requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- id int: Un identificador único para el reproductor
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
GET /2022/06/REST/Devices/12345/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______________________________________________________________
Cuerpo de la respuesta exitosa
200: Devuelve un arreglo de entidades PermisoPermission
Ejemplo
[
{
"entityId": 12345,
"operationUID": "7d71c53e-ae40-59c4-f972-28e8b4dfabcf",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 54321
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-06T15:55:35.587Z"
},
{
"entityId": 12345,
"operationUID": "0cf93b59-dbd4-4ad1-89b4-4024c08d8ddc",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 54321
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-06T15:55:35.553Z"
}
]Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está malformada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /{id}/Permissions/
Aplica permisos que permiten o deniegan la ejecución de operaciones comerciales específicas en un reproductor especificado
Token de alcance requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- id int: Un identificador único para el reproductor
______________________________________________________________
Cuerpo de la solicitud
- Un arreglo de PermisoPermission entidades
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
POST /2022/06/REST/Devices/12345/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: 322Este es el cuerpo de la solicitud de ejemplo:
[
{
"entityId": 12345,
"operationUID": "7d71c53e-ae40-59c4-f972-28e8b4dfabcf",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 54321
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "0001-01-01T00:00:00"
}
]______________________________________________________________
Respuesta exitosa
204: Los permisos especificados se otorgaron correctamente
Respuesta de error
400: La solicitud o el cuerpo de la solicitud tiene un formato incorrecto y, por lo tanto, no es válido, o se rechaza de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
415: El servidor no puede aceptar la representación de datos que usted envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{id}/Permissions/
Elimina los permisos personalizados otorgados para ejecutar operaciones comerciales de un reproductor especificado
Token de alcance requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- id int: Un identificador único para el reproductor
______________________________________________________________
Cuerpo de la solicitud
- Un arreglo de PermisoPermission entidades
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
DELETE /2022/06/REST/Devices/12345/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: 322Este es el cuerpo de solicitud de ejemplo:
[
{
"entityId": 12345,
"operationUID": "7d71c53e-ae40-59c4-f972-28e8b4dfabcf",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 54321
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "0001-01-01T00:00:00"
}
] ______________________________________________________________
Respuesta correcta
204: Los permisos especificados se eliminaron correctamente del reproductor
Respuesta de error
300: No se pudo devolver la representación solicitada porque es ambigua (hay varias representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{serial}/Permissions/
Devuelve la lista de permisos que permiten o deniegan la ejecución de operaciones comerciales específicas en un reproductor especificado
Token de alcance requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- serie se establece en 46D89C001033
GET /2022/06/REST/Devices/46D89C001033/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______________________________________________________________
Cuerpo de respuesta correcta
200: Devuelve una matriz de entidades PermisoPermission
Ejemplo
[
{
"entityId": 12345,
"operationUID": "7d71c53e-ae40-59c4-f972-28e8b4dfabcf",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 54321
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-06T15:55:35.587Z"
},
{
"entityId": 12345,
"operationUID": "0cf93b59-dbd4-4ad1-89b4-4024c08d8ddc",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 54321
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-06T15:55:35.553Z"
}
]Respuesta de error
300: No se pudo devolver la representación solicitada porque es ambigua (hay varias representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /{serial}/Permissions/
Aplica permisos que permiten o deniegan la ejecución de operaciones comerciales específicas en un reproductor especificado
Token de alcance requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
______________________________________________________________
Cuerpo de la solicitud
- Una matriz de entidades PermisoPermission
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- serie se establece en 46D89C001032
POST /2022/06/REST/Devices/46D89C001032/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: 322Este es el cuerpo de solicitud de ejemplo:
[
{
"entityId": 12345,
"operationUID": "7d71c53e-ae40-59c4-f972-28e8b4dfabcf",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 54321
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "0001-01-01T00:00:00"
}
]______________________________________________________________
Respuesta correcta
204: Los permisos especificados se otorgaron correctamente
Respuesta de error
400: La solicitud o el cuerpo de la solicitud están mal formados y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas comerciales
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
415: El servidor no puede aceptar la representación de datos que envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{serial}/Permissions/
Elimina los permisos personalizados otorgados para ejecutar operaciones comerciales de un reproductor especificado
Token de alcance requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
______________________________________________________________
Cuerpo de la solicitud
- Una matriz de entidades de PermisoPermission
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- serie se establece en 46D89C001033
DELETE /2022/06/REST/Devices/46D89C001033/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: 322Este es el cuerpo de la solicitud de ejemplo:
[
{
"entityId": 12345,
"operationUID": "7d71c53e-ae40-59c4-f972-28e8b4dfabcf",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 54321
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "0001-01-01T00:00:00"
}
] ______________________________________________________________
Respuesta correcta
204: Los permisos especificados se eliminaron correctamente del reproductor
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay varias representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según lo especificado en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{serial}/Tokens/{token}/
Valida un token de acceso o actualización de dispositivo OAuth2 en un reproductor especificado
Token de alcance requerido
bsn.api.main.devices.token.validate
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
- token string: Un token de acceso o actualización de dispositivo OAuth2 emitido para el reproductor especificado
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- serie se establece en 47G49C000042
- token se establece en {{Token}}
GET /2022/06/REST/Device/47G49C000042/Tokens/{{Token}}/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UsersAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de la respuesta correcta
200: Devuelve la entidad Entidad de información del token
Ejemplo
{
"token": {{Token}},
"scope": "bdeploy certs bsn.api.device bsn.api.main.groups.regular.retrieve bsn.api.main.groups.regular.schedule.retrieve bsn.api.main.content.retrieve",
"validFrom": "2023-11-29T17:43:55Z",
"validTo": "2023-11-29T17:58:55Z"
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay varias representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{serial}/Tokens/{token}/
Revoca un token de acceso o de actualización de dispositivo OAuth2 en un reproductor especificado
Token de Scope requerido
bsn.api.main.devices.token.revoke
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
- token string: Un token de acceso o de actualización de dispositivo OAuth2 emitido para el reproductor especificado
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de ejemplo de la solicitud se establecen de la siguiente manera:
- serie se establece en 47G49C000042
- token se establece en {{Token}}
DELETE /2022/06/REST/Device/47G49C000042/Tokens/{{Token}}/ 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______________________________________________________________
Respuesta correcta
204: El token especificado se eliminó correctamente del reproductor
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay varias representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud están mal formados y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{id}/Tokens/{token}/
Valida un token de acceso o de actualización de dispositivo OAuth2 en un reproductor especificado
Token de scope requerido
bsn.api.main.devices.token.validate
______________________________________________________________
Segmento
- id int: Un identificador único para el reproductor
- token string: Un token de acceso o de actualización de dispositivo OAuth2 emitido para el reproductor especificado
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 123456
- token se establece en {{Token}}
GET /2022/06/REST/Device/123456/Tokens/{{Token}}/ 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______________________________________________________________
Cuerpo de la respuesta correcta
200: Devuelve la Entidad de información del token
Ejemplo
{
"token": {{Token}},
"scope": "bdeploy certs bsn.api.device bsn.api.main.groups.regular.retrieve bsn.api.main.groups.regular.schedule.retrieve bsn.api.main.content.retrieve",
"validFrom": "2023-11-29T17:43:55Z",
"validTo": "2023-11-29T17:58:55Z"
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y por lo tanto es inválida
401: El token de acceso es inválido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{id}/Tokens/{token}/
Revoca un token de acceso o de actualización de dispositivo OAuth2 en un reproductor especificado
Token de scope requerido
bsn.api.main.devices.revoke
______________________________________________________________
Segmento
- id int: Un identificador único para el reproductor
- token string: Un token de acceso o de actualización de dispositivo OAuth2 emitido para el reproductor especificado
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 123456
- token se establece en {{Token}}
DELETE /2022/06/REST/Device/123456/Tokens/{{Token}}/ 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______________________________________________________________
Respuesta correcta
204: El token especificado se eliminó correctamente del reproductor
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tiene un formato incorrecto y, por lo tanto, no es válido, o se rechaza de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (según lo especificado en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /All/Notes/
Recupera una lista de notas para todos los reproductores de la red.
Token de alcance requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Parámetros de cadena de consulta
- filtro string opcional: Una expresiónexpression para filtrar los resultados de búsqueda. El valor predeterminado es null.
- ordenar string opcional: Una expresión para ordenar los resultados de búsqueda. La expresión de ordenación especifica la entrada utilizada para ordenar y el orden de clasificación ascendente/descendente (ASC/DESC) (consulte esta páginathis page para obtener más información). El valor predeterminado es null.
- marcador string opcional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada isTruncated en el cuerpo de respuesta de la llamada GET anterior indica que el número de instancias de complementos de ejecución automática supera el valor de pageSize. Este parámetro solo es necesario si usted necesita más elementos en la lista paginada que el valor de pageSize (100).
- pageSize int opcional: La cantidad máxima de instancias de reproductor que pueden incluirse en el cuerpo de respuesta. De forma predeterminada, se utiliza el tamaño máximo de página permitido (100).
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- pageSize se establece en 1
- filtro se establece en [Device].[Id] ES '*inaccesible*'
- ordenar se establece en [LastModifiedDate] DESC
- marcador se establece con el valor de la propiedad [PagedList].[NextMarker] de la respuesta anterior de BSN.Cloud API.
GET /2022/06/REST/Devices/All/Notes/?pageSize=1&sort=%5BLastModifiedDate%5D%20DESC&filter=%5BDevice%5D.%5BId%5D%20IS%20%27%2Ainaccessible%2A%27&marker=oxNjo0NydaLDY0Njg2NA%3D 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______________________________________________________________
Cuerpo de la respuesta correcta
200: Devuelve una lista paginadapaged list de instancias de Nota del reproductor en una red. Esto devolverá no más de 100 entidades junto con la información necesaria para devolver cualquier otra página restante.
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{id}/Notes/
Devuelve las notas para un reproductor especificado
Token de alcance requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
id int: Un identificador único para el reproductor
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
GET /2022/06/REST/Devices/12345/Notes/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Mon, 11 Mar 2024 10:00:00 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta correcta con cuerpo
200: Devuelve la instancia de Nota del reproductor para el reproductor especificado.
Ejemplo
{
"device": {
"id": 12345,
"serial": "ABCD12345678"
},
"notes": "This player is behind the TV in an inaccessible place",
"creationDate": "2024-01-10T18:30:11.123Z",
"lastModifiedDate": "2024-03-15T15:51:01.123Z"
}Respuesta correcta
304: El recurso no se modificó desde la hora especificada en el encabezado “If-Modified-Since”
Respuesta de error
300: No se pudo devolver la representación solicitada porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
PUT /{id}/Notes/
Actualiza las notas para el reproductor especificado.
Token de alcance requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- id int: Un identificador único para el reproductor
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
PUT /2022/06/REST/Devices/12345/Notes/ 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, 13 Mar 2024 15:51:01 GMT
Content-Type: application/json
Content-Length: 59Este es el cuerpo de solicitud de ejemplo:
{
"device": {
"id": 12345,
"serial": "ABCD12345678"
},
"notes": "This player is behind the TV in an inaccessible place",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00"
}______________________________________________________________
Respuesta correcta
204: Las notas del reproductor especificado se actualizaron correctamente
Respuesta de error
300: No se pudo devolver la representación solicitada porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso es inválido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
412: Falló la condición previa (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
415: El servidor no puede aceptar la representación de datos que usted envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
GET /{serial}/Notes/
Devuelve las notas de un reproductor especificado
Token de Scope requerido
bsn.api.main.devices.retrieve
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en ABCD12345678
GET /2022/06/REST/Devices/ABCD12345678/Notes/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Mon, 11 Mar 2024 10:00:00 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta correcta con cuerpo
200: Devuelve la instancia de Nota del reproductor para el reproductor especificado
Ejemplo
{
"device": {
"id": 12345,
"serial": "ABCD12345678"
},
"notes": "This player is behind the TV in an inaccessible place",
"creationDate": "2024-01-10T18:30:11.123Z",
"lastModifiedDate": "2024-03-15T15:51:01.123Z"
}Respuesta correcta
304: El recurso no se modificó desde el momento especificado en el encabezado “If-Modified-Since”
Respuesta de error
300: La representación solicitada no pudo ser devuelta porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y por lo tanto es inválida
401: El token de acceso es inválido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
PUT /{serial}/Notes/
Actualiza las notas del reproductor especificado
Token de Scope requerido
bsn.api.main.devices.update
______________________________________________________________
Segmento
- serie string: El número de serie del reproductor
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- serie se establece en ABCD12345678
PUT /2022/06/REST/Devices/ABCD12345678/Notes/ 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, 13 Mar 2024 15:51:01 GMT
Content-Type: application/json
Content-Length: 59Este es el cuerpo de la solicitud de ejemplo:
{
"device": {
"id": 12345,
"serial": "ABCD12345678"
},
"notes": "This player is behind the TV in an inaccessible place",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00"
}______________________________________________________________
Respuesta exitosa
204: La nota del reproductor especificado se actualizó correctamente
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
412: Error de condición previa (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
415: El servidor no puede aceptar la representación de datos que usted envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor