Folder Placement Information

In Wireless Manager, you can have a graphical representation of the placement of locations and devices with respect to one another for the given location. This is called a location layout. Layout for a location folder represents the geographical placement of the sub-locations. The folder Placement Information API call provides information of location tags and placed location on a folder.

API Calls
Get

/V5/layouts/placement

Post

/V5/layouts/placement

Get Placement Information for a Folder Location

Description This API is used to fetch the placement information for a location. It can fetch the information for the floor nodes placed on a folder or the devices placed on a   floor node. It also fetches the location note associated with a location.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
 GET <Base_URL>/layouts/placement?locationid=<value>
  • locationid

    The parameter takes an integer value specifying the ID of the location for which the layout is to be fetched. To retrieve location ID refer Location.
Sample code
 GET https://webapps-mwmmt.airtightnw.com/new/webservice/v5/layouts/placement?locationid=129
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 contains the details of the layout that is being fetched at a location. The response body contains the folder and floor layout details. The response is in the application/json format.

Set Placement Information for a Folder Location

Description This API is used to set the placement information for a location.
Who Can Execute? Superuser, Administrator, and Operator.
Syntax
 POST <Base_URL>/layouts/placement?locationid=<value>
  • locationid

    The parameter takes an integer value specifying the ID of the location for which the layout is to be fetched To retrieve location ID refer Location.
Sample code
POST https://training.mojonetworks.com/new/webservice/v5/layouts/placement?locationid=125
Request Body The request body contains the placement information of the location, for which the layout is to be set.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the details of the layout that is being fetched at a location. The response body contains the folder and floor layout details. The response is in the application/json format.
JSON Table

Attribute Data Type Description
type
location
location/type
location/id
location/parentId
location/name
location/accessibleToUser
location/defaultLocation
location/timezoneId
location/locationTag
location/venueId
location/children
locationTags
locationTags/note
locationTags/description
locationTags/coordinates
locationTags/coordinates/xCordinate
locationTags/coordinates/yCordinate
placedLocations
placedLocations/location
placedLocations/location/type
placedLocations/location/id
placedLocations/location/parentId
placedLocations/location/name
placedLocations/location/accessibleToUser
placedLocations/location/defaultLocation
placedLocations/location/timezoneId
placedLocations/location/locationTag
placedLocations/location/venueId
placedLocations/location/children
placedLocations/coOrdinates
placedLocations/coOrdinates/xCordinate
placedLocations/coOrdinates/yCordinate

Sample JSON 
{
	"type": "folderplacementinfo",
	"location": {
		"type": "folderlocation",
		"id": {
			"type": "locallocationid",
			"id": 0
		},
		"parentId": null,
		"name": "Mojo Networks",
		"accessibleToUser": true,
		"defaultLocation": false,
		"timezoneId": "America/New_York",
		"locationTag": null,
		"venueId": null,
		"children": [{
			"type": "locallocationid",
			"id": -1
		}, {
			"type": "locallocationid",
			"id": 1
		}]
	},
	"locationTags": [{
		"note": "Floor Layout",
		"description": "Layout Placement Info",
		"coordinates": {
			"xCordinate": 445.47759932375317,
			"yCordinate": 158.9180050718512
		}
	}],
	"placedLocations": [{
		"location": {
			"type": "folderlocation",
			"id": {
				"type": "locallocationid",
				"id": 1
			},
			"parentId": {
				"type": "locallocationid",
				"id": 0
			},
			"name": "India",
			"accessibleToUser": true,
			"defaultLocation": false,
			"timezoneId": "Asia/Kolkata",
			"locationTag": null,
			"venueId": null,
			"children": [{
				"type": "locallocationid",
				"id": 27
			}, {
				"type": "locallocationid",
				"id": 12
			}]
		},
		"coOrdinates": {
			"xCordinate": 681.0,
			"yCordinate": 267.0
		}
	}]
}