Extreme Networks Logo
Documentation Powered by ReDoc

ExtremeLocation Heatmap Service APIs (1.0.0)

Download OpenAPI specification:Download

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

ExtremeLocation Heatmap APIs allow you to programmatically generate different types of heatmaps and grid data for the specified parameters.

ExtremeLocation User Documentation

Heatmaps

Create grid data

Generate grid data for the specified parameters.

header Parameters
Authorization
string

An authorization header

Request Body schema: application/json

Site, floor, and band details with grid parameters.

siteParams
object (SiteParamsBean)
gridParams
object (GridParamsBean)

Responses

200

Grid generated successfully

405

Error generating grid. Invalid input.

post /v1/griddata
https://manage.extremelocation.com/eloc-api/gridservices/v1/griddata

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "siteParams":
    {
    },
  • "gridParams":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "gridCacheTimeStamp": 0,
  • "grid":
    {
    },
  • "returnType": "RAW_VALUE"
}

Create heatmap

Generates and returns the heat map for the specified parameters in base 64 encoded format. There are different types of heat maps based on the map type mentioned in request.
(a). mapType : RSSI
This will generate a heat map with the data collected for RTLS calibration. It will indicate the regions with green and red � green for regions with complete data and red for regions with not enough data. (Complete data means, we should have 8 feeds each from at least 4 sensors at that given point).
(b). mapType: CLIENT_DENSITY
This will generate a heat map based on the client density on that point. It will indicate regions with blue, green and red; Blue for regions with minimum density and red for maximum density. CLIENT_DENSITY map can also be generated based on client type : Visitors, Assets and Associates.
(c). mapType: CLIENT_DWELL_TIME
This will generate a heat map based on clients' dwell time at each point . It will indicate regions with blue, green and red; Blue for regions with minimum dwell time and red for maximum dwell time. CLIENT_DWELL_TIME map can also be generated based on client type : Visitors, Assets, and Associates.

header Parameters
Authorization
string

An authorization header.

Request Body schema: application/json

Site,floor, and band details with grid parameters.

siteParams
object (SiteParamsBean)
heatMapParams
object (HeatMapParams)

Responses

200

Heatmap generated successfully

404

Failed to generate heatmap

post /v1/heatmap
https://manage.extremelocation.com/eloc-api/gridservices/v1/heatmap

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "siteParams":
    {
    },
  • "heatMapParams":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "headers":
    {
    },
  • "lastModified": "2019-08-16T14:53:47Z",
  • "date": "2019-08-16T14:53:47Z",
  • "entity": { },
  • "entityTag":
    {
    },
  • "links":
    [
    ],
  • "metadata":
    {
    },
  • "stringHeaders":
    {
    },
  • "mediaType":
    {
    },
  • "allowedMethods":
    [
    ],
  • "cookies":
    {
    },
  • "status": 0,
  • "statusInfo":
    {
    },
  • "length": 0,
  • "language":
    {
    },
  • "location": "http://example.com"
}