Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

Table of Contents
minLevel1
maxLevel3

Status panel

GET - Get

...

Location Status

This method returns the information shown in the Status Panel section for the WifiArea Location indicated by the wifiareaId LocationId parameter.

Code Blockhttps://<server-domainname>/rest/<version>/reports/wifiarea/{wifiareaId}/status

Location


Parameters

TYPE

Parameter

Significance

Type

Required

Default

HEAD

Authorization

Bearer <API_KEY>

String

YES


GET

wifiareaId

LocationId

WifiArea

Location identifier

String

YES



Response

HTTP CODE

Result

Response data

200

Ok


Code Block
{
	"28N2S004": {
		"id": "28XXX004",
		"name": "
WIFIAREA
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 WifiAreas Locations that belong to the WifiArea Location group indicated by the wifiareaGroupId LocationGroupId parameter.

Code Block
https://<server-domainname>/rest/<version>/reports/
wifiareagroups
Locationgroups/{
wifiareaGroupId
LocationGroupId}/status


Parameters

TYPE

Parameter

Significance

Type

Required

Default

HEAD

Authorization

Bearer <API_KEY>

String

YES


GET

wifiareaGroupId

LocationGroupId

WifiArea

Location group identifier

String

YES



Response

HTTP CODE

Result

Response data

200

Ok


Code Block
{
	"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