Puntos finales de suscripciones de dispositivos (2022/06)
Estos endpoints permiten a los usuarios administrar suscripciones de reproductores en una red.
URL base para estos endpoints: https://api.bsn.cloud/2022/06/REST/Subscriptions
_________________________________________________________________________
GET /
Devuelve una lista de suscripciones de reproductores
Token de Scope requerido
bsn.api.main.subscriptions.retrieve
______________________________________________________________
Parámetros de Query String
- filtro string opcional: Una expresiónexpresión de búsqueda para reducir el conjunto de resultados
- 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áginaesta página para obtener más información).
- 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 suscripción de reproductores excede 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 suscripción de dispositivos 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:
- marcador tiene el valor de la propiedad [PagedList].[NextMarker] de la respuesta anterior de BSN.Cloud API.
- pageSize tiene el valor de 1
- filtro tiene el valor de [Dispositivo] ES NULO Y [Estado] ESTÁ EN ('Activo', 'Suspendiendo')
- ordenar tiene el valor de [CreationDate] DESC
GET /2022/06/REST/Subscriptions/?marker=NDI0NTY0LDQyNDU2NA%3D%3D&pageSize=1&filter=%5BDevice%5D%20IS%20NULL%20AND%20%5BStatus%5D%20IS%20IN%20%28%27Active%27%2C%20%27Suspending%27%29&sort=%5BCreationDate%5D%20DESC HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de respuesta exitosa
200: Devuelve una lista paginadalista paginada de entidades de Suscripción de 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.
Ejemplo
{
"items": [ {
"id": 424574,
"device": null,
"type": "Commercial",
"activityPeriod": "365.00:00:00",
"status": "Active",
"creationDate": "2023-06-02T07:02:52.99Z",
"lastModifiedDate": "2023-06-02T07:02:52.99Z",
"activationDate": "2023-06-02T07:02:52.99Z",
"suspensionDate": null,
"expirationDate": null
}],
"totalItemCount": 20,
"matchingItemCount": 9,
"pageSize": 1,
"nextMarker": "MjAyMy0wNi0wMlQwNzowMjo1Mi45OTBaLDQyNDU3NA==",
"prevMarker": "MjAyMy0wNi0wMlQwNzowMjo1Mi45OTBaLDQyNDU36H78",
"isTruncated": true,
"sortExpression": "[CreationDate] DESC",
"filterExpression": "[Device] IS NULL AND [Status] IS IN ( 'Active' , 'Suspending' )"
}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 es 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 /Count/
Recupera el número de instancias de suscripción 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 instancias de suscripción en la red.
Token de alcance requerido
bsn.api.main.subscriptions.retrieve
______________________________________________________________
Parámetro de cadena de consulta
- filtro string opcional: Una expresiónexpresión para filtrar resultados de búsqueda. El valor predeterminado es null.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- filtro se establece en[Id] ES MAYOR QUE 0 Y [Status] ESTÁ EN ('Activo', 'Suspendiendo')
GET /2022/06/REST/Subscriptions/Count/?pageSize=0&filter=%5BId%5D%20IS%20GREATER%20THAN%200%20AND%20%5BStatus%5D%20IS%20IN%20%28%27Active%27%2C%20%27Suspending%27%29 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 conteo de instancias de suscripción 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 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 es 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 /Operations/
Devuelve permisos operativos otorgados a 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/Subscriptions/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 exitosa
200: Devuelve la Entidad de operaciones comercialesBusiness Operations Entity
Ejemplo
Respuesta de error
300: No se pudo devolver la representación solicitada 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 es 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