GET api/v2/locations/{id}

Get location by unique identificator

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Unique identificator of the location	string	Required

Body Parameters

None.

Response Information

Resource Description

Location object

LocationDetails

Name	Description	Type	Additional information
parent-location	Parent location	LocationSimple	None.
name	Name of location	string	None.
description	Location description	string	None.
class	Location class	LocationClassDetails	None.
movable	If the location is movable	boolean	None.
perimeter	If the location is in Perimeter (1) or not (0)	integer	None.
location-control	Location control	integer	None.
map-area	Location area details	LocationMapDetails	None.
update-date	Update date (sync)	date	None.
tags	Tags associated with the location	Collection of TagDetails	None.
status	Status (active or not)	TagvueEntityStatus	None.
entity-id	Identifying entity-id of the entity, this is expected to be unique	string	None.

Response Formats

application/xml, text/xml

Sample:

<location entity-id="sample string 5" xmlns="urn:tagvue:am">
  <status>inactive</status>
  <parent-location entity-id="sample string 2">
    <name>sample string 1</name>
  </parent-location>
  <name>sample string 1</name>
  <description>sample string 2</description>
  <location-class entity-id="sample string 7">
    <status>inactive</status>
    <parent-class entity-id="sample string 2">
      <name>sample string 1</name>
    </parent-class>
    <name>sample string 1</name>
    <description>sample string 2</description>
    <virtual>true</virtual>
    <color>sample string 4</color>
    <icon-uri>sample string 5</icon-uri>
    <image-uri>sample string 6</image-uri>
  </location-class>
  <movable>true</movable>
  <perimeter>1</perimeter>
  <location-control>3</location-control>
  <map-area entity-id="sample string 8">
    <status>inactive</status>
    <northwest>
      <latitude>1.1</latitude>
      <longitude>1.1</longitude>
    </northwest>
    <northeast>
      <latitude>1.1</latitude>
      <longitude>1.1</longitude>
    </northeast>
    <southeast>
      <latitude>1.1</latitude>
      <longitude>1.1</longitude>
    </southeast>
    <southwest>
      <latitude>1.1</latitude>
      <longitude>1.1</longitude>
    </southwest>
    <altitude>1.1</altitude>
    <angle>1.1</angle>
    <image-uri>sample string 1</image-uri>
    <provider>2</provider>
    <geoJSON>sample string 3</geoJSON>
    <floorplan-picture-width>1</floorplan-picture-width>
    <floorplan-picture-height>1</floorplan-picture-height>
    <floorplan-tile-size>1</floorplan-tile-size>
    <floorplan-tiles-path>sample string 4</floorplan-tiles-path>
    <floorplan-tiles-error-path>sample string 5</floorplan-tiles-error-path>
    <floor-width>1.1</floor-width>
    <floor-height>1.1</floor-height>
    <floorplan-background-color>sample string 6</floorplan-background-color>
    <update-date>2025-05-30T18:41:07.1826957-07:00</update-date>
  </map-area>
  <update-date>2025-05-30T18:41:07.1826957-07:00</update-date>
  <tags>
    <tag entity-id="sample string 3">
      <status>inactive</status>
      <last-seen-time>2025-05-30T18:41:07.1826957-07:00</last-seen-time>
      <last-seen-location entity-id="sample string 2">
        <name>sample string 1</name>
      </last-seen-location>
      <previous-location entity-id="sample string 2">
        <name>sample string 1</name>
      </previous-location>
      <tag-status-user entity-id="sample string 1">
        <name>sample string 2</name>
        <email>sample string 3</email>
        <employee-id>sample string 4</employee-id>
        <phone>sample string 5</phone>
      </tag-status-user>
      <enrolled-by entity-id="sample string 1">
        <name>sample string 2</name>
        <email>sample string 3</email>
        <employee-id>sample string 4</employee-id>
        <phone>sample string 5</phone>
      </enrolled-by>
      <latitude>1.1</latitude>
      <longitude>1.1</longitude>
      <disposition>unknown</disposition>
      <type>Barcode</type>
      <create-date>2025-05-30T18:41:07.1826957-07:00</create-date>
      <update-date>2025-05-30T18:41:07.1826957-07:00</update-date>
      <entity entity-id="sample string 1" type="None" />
    </tag>
    <tag entity-id="sample string 3">
      <status>inactive</status>
      <last-seen-time>2025-05-30T18:41:07.1826957-07:00</last-seen-time>
      <last-seen-location entity-id="sample string 2">
        <name>sample string 1</name>
      </last-seen-location>
      <previous-location entity-id="sample string 2">
        <name>sample string 1</name>
      </previous-location>
      <tag-status-user entity-id="sample string 1">
        <name>sample string 2</name>
        <email>sample string 3</email>
        <employee-id>sample string 4</employee-id>
        <phone>sample string 5</phone>
      </tag-status-user>
      <enrolled-by entity-id="sample string 1">
        <name>sample string 2</name>
        <email>sample string 3</email>
        <employee-id>sample string 4</employee-id>
        <phone>sample string 5</phone>
      </enrolled-by>
      <latitude>1.1</latitude>
      <longitude>1.1</longitude>
      <disposition>unknown</disposition>
      <type>Barcode</type>
      <create-date>2025-05-30T18:41:07.1826957-07:00</create-date>
      <update-date>2025-05-30T18:41:07.1826957-07:00</update-date>
      <entity entity-id="sample string 1" type="None" />
    </tag>
  </tags>
</location>

application/json, text/json

Sample:

{
  "parent-location": {
    "name": "sample string 1",
    "entity-id": "sample string 2"
  },
  "name": "sample string 1",
  "description": "sample string 2",
  "class": {
    "parent-class": {
      "name": "sample string 1",
      "entity-id": "sample string 2"
    },
    "name": "sample string 1",
    "description": "sample string 2",
    "virtual": true,
    "color": "sample string 4",
    "icon-uri": "sample string 5",
    "image-uri": "sample string 6",
    "status": 0,
    "entity-id": "sample string 7"
  },
  "movable": true,
  "perimeter": 1,
  "location-control": 3,
  "map-area": {
    "northwest": {
      "latitude": 1.1,
      "longitude": 1.1
    },
    "northeast": {
      "latitude": 1.1,
      "longitude": 1.1
    },
    "southeast": {
      "latitude": 1.1,
      "longitude": 1.1
    },
    "southwest": {
      "latitude": 1.1,
      "longitude": 1.1
    },
    "altitude": 1.1,
    "angle": 1.1,
    "image-uri": "sample string 1",
    "provider": 2,
    "geoJSON": "sample string 3",
    "floorplan-picture-width": 1,
    "floorplan-picture-height": 1,
    "floorplan-tile-size": 1,
    "floorplan-tiles-path": "sample string 4",
    "floorplan-tiles-error-path": "sample string 5",
    "floor-width": 1.1,
    "floor-height": 1.1,
    "floorplan-background-color": "sample string 6",
    "update-date": "2025-05-30T18:41:07.1826957-07:00",
    "status": 0,
    "entity-id": "sample string 8"
  },
  "update-date": "2025-05-30T18:41:07.1826957-07:00",
  "tags": [
    {
      "last-seen-time": "2025-05-30T18:41:07.1826957-07:00",
      "last-seen-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "previous-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "tag-status-user": {
        "entity-id": "sample string 1",
        "name": "sample string 2",
        "email": "sample string 3",
        "employee-id": "sample string 4",
        "phone": "sample string 5"
      },
      "enrolled-by": {
        "entity-id": "sample string 1",
        "name": "sample string 2",
        "email": "sample string 3",
        "employee-id": "sample string 4",
        "phone": "sample string 5"
      },
      "latitude": 1.1,
      "longitude": 1.1,
      "disposition": 0,
      "type": 0,
      "create-date": "2025-05-30T18:41:07.1826957-07:00",
      "update-date": "2025-05-30T18:41:07.1826957-07:00",
      "entity": {
        "Id": "sample string 1",
        "Type": 0
      },
      "status": 0,
      "entity-id": "sample string 3"
    },
    {
      "last-seen-time": "2025-05-30T18:41:07.1826957-07:00",
      "last-seen-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "previous-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "tag-status-user": {
        "entity-id": "sample string 1",
        "name": "sample string 2",
        "email": "sample string 3",
        "employee-id": "sample string 4",
        "phone": "sample string 5"
      },
      "enrolled-by": {
        "entity-id": "sample string 1",
        "name": "sample string 2",
        "email": "sample string 3",
        "employee-id": "sample string 4",
        "phone": "sample string 5"
      },
      "latitude": 1.1,
      "longitude": 1.1,
      "disposition": 0,
      "type": 0,
      "create-date": "2025-05-30T18:41:07.1826957-07:00",
      "update-date": "2025-05-30T18:41:07.1826957-07:00",
      "entity": {
        "Id": "sample string 1",
        "Type": 0
      },
      "status": 0,
      "entity-id": "sample string 3"
    }
  ],
  "status": 0,
  "entity-id": "sample string 5"
}