api-object-access

Heat Maps

Heat Maps are used to help the user to visualize the coverage, link speed and channels of placed devices on the floor plan. The user can select a different view of the floor plan to visualize the device placements, AP Coverage, AP Link Speed and AP Channel Coverage of the floor plan. Heats Maps are available on the Mojo Aware UI.

JSON Table

Attribute Data Type Description Default/Sample value
status String SUCCESSFUL
result
result/coordinates
result/coordinates/xCordinate int 178.39943719515176
result/coordinates/yCordinate int 112.86338054325071
result/coordinates/value int -117.72610480298734
cellSize
cellSize/xCordinate int 3.448450739100096
cellSize/yCordinate int 3.448450739100096
expiryTime int It is the timestamp when the result will be deleted. It is 0 when status
is not “SUCCESSFUL”		 1519819136965

Copy Sample JSON
Sample JSON 
{
	"status": "SUCCESSFUL",
	"result": [{
		"coordinates": {
			"xCordinate": 178.39943719515176,
			"yCordinate": 112.86338054325071
		},
		"value": -117.72610480298734
	}, {
		"coordinates": {
			"xCordinate": 84.48704310795236,
			"yCordinate": 12.069577586850336
		},
		"value": -179.36733909152497
	},  {
		"coordinates": {
			"xCordinate": 32.76028202145091,
			"yCordinate": 25.86338054325072
		},
		"value": -180.0178049202931
	},
    . . .
    . . .
    . . .    
	{
		"coordinates": {
			"xCordinate": 84.48704310795236,
			"yCordinate": 99.06957758685033
		},
		"value": -47.93432041330284
	}, {
		"coordinates": {
			"xCordinate": 240.47155049895375,
			"yCordinate": 130.1056342387512
		},
		"value": -167.00356291731092
	},  ],
	"cellSize": {
		"xCordinate": 3.448450739100096,
		"yCordinate": 3.448450739100096
	},
	"expiryTime": 1519819136965
}
API Calls
Get

/v5/layouts/heatmaps/requests/{requestid}

Post

/v5/layouts/heatmaps/requests

Delete

/v5/layouts/heatmaps/requests/{request_id}

Get Heatmaps Details

Description On the successful completion of the request the API provides status and result associated with the given request.
Syntax
GET <Base_URL>/layouts/heatmaps/requests/{requestid}

Here,

  • requestid

    It’s a unique system generated ID for the logged request. This ID can be used to query status and results associated with this request. It takes String value.
Sample
https://training.mojonetworks.com/new/webservice/v5/layouts/heatmaps/requests/
8e41795f-69d1-4e35-9867-5adba61b0f1b
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body returns status and result associated with the given request. After completion of the request, the result will be automatically deleted after 10 minutes. The response is in the application/json format.

Log a Request to Generate Heatmap

Description This API logs a request to generate heatmap with the given data in the request body.
Syntax
POST <Base_URL>/layouts/heatmaps/requests?locationid=<value>

Here,

  • locationid

    The ID of the location where the heatmaps are to be generated. It takes an integer value. To retrieve location ID refer location.
Sample
POST https://training.mojonetworks.com/new/webservice/v4/layouts/heatmaps/requests?locationid=7
Request Body The request body contains the

Sample Request Body:

{
	"protocols": ["2.4", "5"],
	"resolution": "LOW",
	"heatmapType": "AP_COVERAGE",
	"placementInfo": {
		"placedManagedDevices": [{
			"boxId": 2,
			"coordinates": {
				"xCordinate": 82.47501830161053,
				"yCordinate": 80.75507003554297
			},
			"transmitPower": 14.8
		}],
		"placedAPs": []
	},
	"rssiThreshold": -77
}
Response Body If the API call is successful, the HTTP response status is 200.
The response body returns the request ID for the logged in request to generate heatmap. The response is in the application/json format.

Delete Heatmap

Description This API will cancel a running request and/or delete results of a completed operation.
Syntax
DELETE <Base_URL>/layouts/heatmaps/requests/{requestid}

Here,

  • requestid

    It’s a unique system generated ID for the logged request. This ID can be used to query status and results associated with this request. It takes String value.
Sample Code
DELETE https://training.mojonetworks.com/new/webservice/v5/layouts/heatmaps/requests/
8e41795f-69d1-4e35-9867-5adba61b0f1b
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any other information.