The following is a description of the Octopus platform API methods related to the Monitoring module, which allow, for example, to check when the last validation of a user in a Location has been performed.
Status panel
GET - Get Location Status
This method returns the information shown in the Status Panel section for the Location indicated by the LocationId parameter.
Location |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | LocationId | Location identifier | String | YES |
Response
HTTP CODE | Result | Response data |
|---|---|---|
200 | Ok | {
"28N2S004": {
"id": "28XXX004",
"name": "Location 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 | Explanation of the error |
GET - Get Location Group Status
This method returns the information shown in the Status Panel section for the Locations that belong to the Location group indicated by the LocationGroupId parameter.
https://<server-domainname>/rest/<version>/reports/Locationgroups/{LocationGroupId}/status
|
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | LocationGroupId | Location group identifier | String | YES |
Response
HTTP CODE | Result | Response data |
|---|---|---|
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 | Explanation of the error |