Módulo Monitorización
- Pedro Doroshenko
- Santiago Nanclares (Unlicensed)
A continuación se describen los métodos de la API de la plataforma Octopus referentes al módulo Monitorización, los cuales permiten por ejemplo comprobar cuándo se ha realizado la última validación de un usuario en una Localización.
Panel de Estados
GET - Get Location Status
Devuelve la información del módulo Panel de Estados de la plataforma Octopus para la Localización indicada mediante el parámetro LocationId.
https://<server-domainname>/rest/<version>/reports/Location/{LocationId}/status |
Parámetros
TYPE | Parametro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | LocationId | Identificador de la Localización | String | SI |
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
{
"28XXX004": {
"id": "28XXX004",
"name": "name",
"address": "C/ Valentin Beato 22",
"lat_lng": "41.72217,-3.569137",
"avatar": "340",
"devices": "2.1613",
"total_time": "44719.63171935",
"total_upload": "104487983.48870968",
"total_download": "62382492.51182903",
"last_session": "2017-10-20 14:52:15"
}
} |
401 | Unauthorized | Explicación del error |
GET - Get Location Group Status
Devuelve la información del módulo Panel de Estados de la plataforma WIFI para todos las Localizaciones pertenecientes al grupo de Localizaciones indicada mediante el parámetro LocationGroupId.
https://<server-domainname>/rest/<version>/reports/Locationgroups/{LocationGroupId}/status |
Parámetros
TYPE | Parametro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | LocationGroupId | Identificador del grupo de Localizaciones | String | SI |
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
{
"ITXXX006": {
"id": "ITXXX006",
"name": "Oficinas Milan",
"address": "Calle Valentin Beato, 370, 20122 Milano,",
"lat_lng": "44.421369,9.269482",
"avatar": "489",
"devices": null,
"total_time": null,
"total_upload": null,
"total_download": null
}
} |
401 | Unauthorized | Explicación del error |