v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Location

Get device location details

Return the location information for a device identified by the required parameters site-id and serial-number. The device must exist in the system and have associated location data.

get/network-services/v1/sites/{site-id}/devices/{serial-number}/location

Path parameters

site-idstring uuid required

Site ID associated with the device commonly in UUID format.

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

serial-numberstring const required

The device serial number.

The device serial for which the location information is being requested.

Response

Object containing the device's geographic coordinates matching the request criteria. If no device with the requested information is found, then an empty list is returned.

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'