Get location resource

This API provides the location details for a specific location resource. The site-id must be provided alongside the location-id to properly fetch the location data. Each unique location-id represents a change in device location, for example if an AP was moved from one floorplan to another a new location resource with a unique location-id will be created.

site-idstring uuid required

Site ID associated with the device commonly in UUID format.

ID of the Site for which device location information is requested.

location-idstring const required

Uniquely generated ID for a device location.

The ID of the location resource to be fetched.

Response

Returned device location resource.

idstring const required

Uniquely generated ID for a device location.

serialNumberstring const

The device serial number.

type'ACCESS_POINT' | 'SWITCH' | 'GATEWAY' required

A string indicating the networking device type.

{"stackTrail":"components:schemas:Timestamp","oasType":"schema","type":"unknown","description":"Timestamp in ISO 8601 format with a precision of seconds. \nThe time is in the UTC timezone.\n\nFormat: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]\n"}

siteIdstring uuid required

Site ID associated with the device commonly in UUID format.

{"stackTrail":"components:schemas:BuildingId","oasType":"schema","type":"unknown","description":"Building ID associated with the device in UUID format. Omitted if no specific building is associated with the device.\n"}

{"stackTrail":"components:schemas:FloorId","oasType":"schema","type":"unknown","description":"Floor ID associated with the device in UUID format.\n"}

{"stackTrail":"components:schemas:FloorLevel","oasType":"schema","type":"unknown","description":"If included this field contains a logical representation of the floor level. This value is relevant only in relation to a building; the value is relative to the ground level of the building which is assigned the number 0.\n\nDetermining what floor is at ground level and what constitutes a sub-floor as opposed to a naturally numbered floor is left to local interpretation.\n\nLarger values represent floors that are farther away from floor 0 such that\n* if positive the floor value is farther above the ground floor\n* if negative the floor value is farther below the ground floor\n\nNon-integer values can be used to represent intermediate or sub-floors, such as mezzanine levels. Example: a mezzanine between floor 1 and floor 2 could be represented as a value of 1.25. Example: mezzanines between floor 4 and floor 5 could be represented as values of 4.5 and 4.75.\n\nIf the field is absent floor 0 must be assumed.\n"}

{"stackTrail":"components:schemas:DeviceLocationSummary:properties:tenantId","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:DeviceLocationSummary:properties:ipv4","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:DeviceLocationSummary:properties:ipv6","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:DeviceLocationSummary:properties:macAddress","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:DeviceLocationSummary:properties:model","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:DeviceLocationSummary:properties:deployment","oasType":"schema","type":"unknown"}

status'ONLINE' | 'OFFLINE'

v1

Get location resource

Path parameters

Response