ExtremeLocation Calibration APIs (1.0.0)

Download OpenAPI specification:Download

Extreme Networks Support: support@extremenetworks.com URL: https://www.extremenetworks.com

ExtremeLocation Calibration service APIs allow you to programmatically access and manage calibration data for both sensor and zone calibration.

ExtremeLocation User Documentation

Calibration Stop Resource

Stop floor calibration

Stops the calibration of the floor. The parameter required are as follows.
siteId : Site Identifier.
clientId : Primary device MAC.
floorId : Floor Identifier.

header Parameters

Authorization

string

Anauthorization header.

Request Body schema: application/json

Client floor and site for which the calibration is started.

siteId	string
clientId	string
floorId	string

Responses

200

Calibration stopped for given floor.

404

Page Not found

405

Invalid input

post /v1/calibration/stop

https://manage.extremelocation.com/eloc-api/calibration/v1/calibration/stop

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"siteId": "string",
"clientId": "string",
"floorId": "string"

}

Stop zone Calibration for a floor

Stops Zone Calibration for a floor.

header Parameters

Authorization

string

An authorization header

Request Body schema: application/json

Client, floor, and site for which the calibration is started.

siteId	string
clientId	string
floorId	string

Responses

200

Stopped zone calibration for floor

404

Error while stopping calibration for floor

post /v1/calibration/zone/ap/stop

https://manage.extremelocation.com/eloc-api/calibration/v1/calibration/zone/ap/stop

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"siteId": "string",
"clientId": "string",
"floorId": "string"

}

Stop sensor zone calibration

Stops the calibration for a sensor zone. The parameters required are as follows.
siteId : Site Identifier.
clientId : Primary device MAC.
floorId : Floor Identifier.

header Parameters

Authorization

string

Request Body schema: application/json

Client floor and site for which the calibration is started.

siteId	string
clientId	string
floorId	string

Responses

200

Sensor zone calibration stopped successfully.

404

Error while stopping the calibration.

405

Invalid input.

post /v1/calibration/zone/stop

https://manage.extremelocation.com/eloc-api/calibration/v1/calibration/zone/stop

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"siteId": "string",
"clientId": "string",
"floorId": "string"

}

Save Calibration Resource

Retrieves Calibration Data

query Parameters

siteId required	string siteId
clientId required	string clientId
floorId required	string floorId

Responses

400

Bad Request

404

Sites not found

500

Internal Server Error

get /v1/calibration/data

https://manage.extremelocation.com/eloc-api/calibration/v1/calibration/data

Save calibrated data

Saves the location coordinates for which the data (feeds from sensors) will be collected. The parameters required are as follows.
locX : X coordinate of the point in the floor.
locY : Y coordinate of the point in the floor.
siteId : Site Identifier.
clientId : Primary device MAC.
floorId : Floor Identifier.

Request Body schema: application/json

Location for which the data collection is started

locX	number <float>
locY	number <float>
siteId	string
clientId	string
floorId	string

Responses

200

Data saved successfully

404

Page not found

405

Invalid ID supplied

post /v1/calibration/data

https://manage.extremelocation.com/eloc-api/calibration/v1/calibration/data

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"locX": 0,
"locY": 0,
"siteId": "string",
"clientId": "string",
"floorId": "string"

}

Start Calibration Resource

Start floor calibration

Starts the calibration for a floor. The service supports calibration with 2 devices, one for each band (2.4 and 5 ). In this case you need select one device as primary and all the communication to the server will be through the primary device. * The parameters required are as follows.
secClientId : Client ID of the device which is used as secondary device.
wifiBand : Wi fi band for which the calibration is being done. Needed only if it is doing for one band.
siteId : Site identifier.
clientId : Primary device MAC.
floorId : Floor identifier.

header Parameters

Authorization

string

An authorization header.

Request Body schema: application/json

Client and floor for which the calibration is started

secClientId	string
wifiBand	string
siteId	string
clientId	string
floorId	string

Responses

200

Calibration started successfully.

404

Page not found.

405

Invalid input.

post /v1/calibration/start

https://manage.extremelocation.com/eloc-api/calibration/v1/calibration/start

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"secClientId": "string",
"wifiBand": "string",
"siteId": "string",
"clientId": "string",
"floorId": "string"

}

Start calibration for sensor zone

Starts the calibration for a sensor zone. The parameters are as follows.
siteId : Site Identifier.
clientId : Primary MAC id.
floorId : Floor Identifier.
AP : Sensor MAC of the zone sensor.

header Parameters

Authorization

string

An authorization key.

Request Body schema: application/json

Client, floor, and access point for which the calibration is started

siteId	string
clientId	string
floorId	string
AP	string

Responses

200

Sensor zone calibration started successfully.

404

Error starting calibration.

post /v1/calibration/zone/ap/start

https://manage.extremelocation.com/eloc-api/calibration/v1/calibration/zone/ap/start

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"siteId": "string",
"clientId": "string",
"floorId": "string",
"AP": "string"

}

Start zone calibation

Starts the zone calibration for a floor. The calibration can be done with multiple devices, in that case one device will be selected as the primary device and all the communication with the server will be through primary device. The parameters required are as follows.
siteId : Site Identifier.
priClient : MAC of the primary client id.
clientList : MAC IDs of all the devices which will be used for calibration.
floorId : Floor Identifier.

header Parameters

Authorization

string

An authorization header.

Request Body schema: application/json

Client and floor for which the zone calibration is started.

siteId	string
priClient	string
clientList	Array of strings
floorId	string

Responses

200

Started zone calibration succesfully.

404

Page not found.

405

Invalid input.

post /v1/calibration/zone/start

https://manage.extremelocation.com/eloc-api/calibration/v1/calibration/zone/start

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"siteId": "string",
"priClient": "string",
"clientList":
[
- "string"
],
"floorId": "string"

}

ADSP Calibration Resource

Save ADSP calibration data

API to save calibration marker data during ADSP data migration.

Request Body schema: application/json

JSON object containing calibration data

string

Responses

200

Data saved successfully.

500

Internal Server Error.

post /v1/migrate/adsp/mlz/data

https://manage.extremelocation.com/eloc-api/calibration/v1/migrate/adsp/mlz/data

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

"string"

Get the calibration data

Retrieve sensor data

This API returns all calibrated points with details of percentage of data collected by each sensor

query Parameters

siteId required	string siteId
floorId required	string floorId
clientId required	string clientId

header Parameters

Authorization

string

An authorization key

Responses

400

Bad Request

404

Sites not found

500

Internal Server Error

get /v1/calb/floor/markers

https://manage.extremelocation.com/eloc-api/calibration/v1/calb/floor/markers

Retrieve data collected by different sensors at a marker

This API returns percentage of data collected by different sensors at a given marker

query Parameters

site required	string site
floor required	string floor
client required	string client
locX required	number <float> locX
locY required	number <float> locY

header Parameters

Authorization

string

Responses

200

Data retrived successfully.

404

Page not found

500

Processing error.

get /v1/calb/marker/details

https://manage.extremelocation.com/eloc-api/calibration/v1/calb/marker/details

Retrieve currrent calibration point data

This API returns percentage of data collected by different sensor for the current calibration point

query Parameters

data

required

string

input

header Parameters

Authorization

string

An authorization key

Responses

200

Data retrived successfully

404

Page not found

500

Processing error

get /v1/calb/markers/info

https://manage.extremelocation.com/eloc-api/calibration/v1/calb/markers/info

Retrieve data points for a sensor

query Parameters

siteId required	string siteId
floorId required	string floorId
clientId required	string clientId

header Parameters

Authorization

string

An authorization header

Responses

400

Bad Request

404

Sites not found

500

Internal Server Error

get /v1/datapoints/ap

https://manage.extremelocation.com/eloc-api/calibration/v1/datapoints/ap

Retrieve analytics on RSSI value

query Parameters

siteId required	string siteId
floorId required	string floorId
client required	string client
ap required	string AP

header Parameters

Authorization

string

An authorization key

Responses

400

Bad Request

404

Sites not found

500

Internal Server Error

get /v1/zone/analytics/ap

https://manage.extremelocation.com/eloc-api/calibration/v1/zone/analytics/ap

Retrieve RSSI analytics of floor

query Parameters

siteId required	string siteId
floorId required	string floorId
clientId required	string clientId

header Parameters

Authorization

string

An authorization key

Responses

400

Bad Request

404

Sites not found

500

Internal Server Error

get /v1/zone/analytics/floor

https://manage.extremelocation.com/eloc-api/calibration/v1/zone/analytics/floor