---
title: "Get location resource"
method: GET
path: "/network-services/v1/sites/{site-id}/device-locations/{location-id}"
tags: ["Location"]
---

# Get location resource

`GET /network-services/v1/sites/{site-id}/device-locations/{location-id}`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-services/v1/sites/{site-id}/device-locations/{location-id}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`
- TypeScript: <https://skmtc.dev/arubanetworks/apis/authorization/docs/network-services/v1/sites/:site-id/device-locations/:location-id/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `site-id` string, uuid, required: Site ID associated with the device commonly in UUID format.
- `location-id` string, const, required: Uniquely generated ID for a device location.

## Response `200`

Returned device location resource.

- DeviceLocationSummary: Geographic coordinates of a device. **consolidatedLocation** contains the best estimate of the device location. The location in this field can be derived automatically by the system or overridden manually by the system administrator (by placing it on a floorplan or via another NBAPI call). The sytem generated location is almost always available, when an AP is removed from a floorplan then the system generated location will be used as the consolidated location.
  - `id` string, const, required: Uniquely generated ID for a device location.
  - `serialNumber` string, const: The device serial number.
  - `type` 'ACCESS_POINT' | 'SWITCH' | 'GATEWAY', required: A string indicating the networking device type.
  - `createdAt` unknown, required
  - `siteId` string, uuid, required: Site ID associated with the device commonly in UUID format.
  - `buildingId` unknown
  - `floorId` unknown, required
  - `floorLevel` unknown
  - `tenantId` unknown
  - `ipv4` unknown
  - `ipv6` unknown
  - `macAddress` unknown
  - `model` unknown
  - `deployment` unknown
  - `status` 'ONLINE' | 'OFFLINE'
  - `consolidatedLocation` Location: Longitude, latitude, altitude and floor position. The system can return location uncertainty in two formats. The **LCIUncertainty** field is a similar ellipse but with a fixed orientation such that its axes are parallel to the north-south and east-west geographic directions. The system will return both uncertainty representations if they are available. Note that for a given data set the uncertaintyEllipse will always describe an area equal to or smaller than the LCIUncertainty.
    - `source` 'ADMIN_SPECIFIED' | 'SYSTEM_GENERATED', required: Source of the device coordinates. * 'ADMIN_SPECIFIED' - The device location was administratively entered. * 'SYSTEM_GENERATED' - The location automatically determined by the system.
    - `timestamp` unknown, required
    - `cartesianCoordinates` CartesianCoordinates: The x and y coordinates on the plane representing the associated floorplan for this device.
      - `unit` 'METERS' | 'FEET': The units of measure for xPosition and yPosition.
      - `xPosition` unknown, required
      - `yPosition` unknown, required
    - `center` Center, required: Contains the coordinates of the center of the area of location uncertainty for the device.
      - `longitude` unknown, required
      - `latitude` unknown, required
    - `lciUncertainty` LCIUncertainty: Uncertainty ellipse centered on the latitude and longitude of the "center" field of the parent object. The axes of this ellipse are parallel to north-south and east-west directions.
      - `longitudeUncertainty` unknown, required
      - `latitudeUncertainty` unknown, required
      - `confidenceLevel` unknown
    - `altitude` Altitude: Describes a vertical elevation.
      - `elevationType` 'ABOVE_MEAN_SEA_LEVEL' | 'ABOVE_GROUND_LEVEL' | 'UNKNOWN', required: Identifies the vertical datum used to measure the device elevation. * 'ABOVE_MEAN_SEA_LEVEL' - Above Mean Sea Level, the elevation in meters in relation to the zero set by the vertical WGS 84 datum * 'ABOVE_GROUND_LEVEL' - Above Ground Level, the elevation in meters above the local ground level * 'UNKNOWN' - The elevation type is unknown
      - `elevation` unknown, required
      - `elevationUncertainty` unknown

## Other responses

- `400`: Invalid input received.
- `401`: Unauthorized. Authentication credentials are required or invalid.
- `403`: Forbidden: Access is denied.
- `429`: Too Many Requests. The user has sent too many requests in a given amount of time.
- `500`: Internal Server Error. An unexpected error occurred on the server.

---

[API](https://skmtc.dev/arubanetworks/apis/authorization.md) - [All operations](https://skmtc.dev/arubanetworks/apis/authorization/llms.txt) - [OpenAPI document](https://skmtc.dev/arubanetworks/apis/authorization/revisions/74c95058b11f?raw)