GET api/v2/locations?Skip={Skip}&Take={Take}&Since={Since}&Name={Name}

Get locations based on filters

Request Information

URI Parameters

Name	Description	Type	Additional information
Skip	Number of items you want to skip in the search (optional)	integer	None.
Take	Number of items to return in the result set of the search operation (optional)	integer	None.
Since	Return only items which have Update-Date greater then (optional)	date	None.
Name	Filter by entity name (if applicable)	string	None.

Body Parameters

None.

Response Information

Resource Description

Location list

LocationOverviewList

Name	Description	Type	Additional information
locations	Location collections	Collection of LocationOverview	None.

Response Formats

application/xml, text/xml

Sample:

<locations xmlns="urn:tagvue:am">
  <location entity-id="sample string 4">
    <status>inactive</status>
    <parent-location entity-id="sample string 2">
      <name>sample string 1</name>
    </parent-location>
    <name>sample string 1</name>
    <class entity-id="sample string 2">
      <name>sample string 1</name>
    </class>
    <movable>true</movable>
    <perimeter>1</perimeter>
    <location-control>2</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-11-08T04:42:55.882723-08:00</update-date>
    </map-area>
    <update-date>2025-11-08T04:42:55.882723-08:00</update-date>
    <tags>
      <tag entity-id="sample string 1">
        <status>inactive</status>
      </tag>
      <tag entity-id="sample string 1">
        <status>inactive</status>
      </tag>
    </tags>
  </location>
  <location entity-id="sample string 4">
    <status>inactive</status>
    <parent-location entity-id="sample string 2">
      <name>sample string 1</name>
    </parent-location>
    <name>sample string 1</name>
    <class entity-id="sample string 2">
      <name>sample string 1</name>
    </class>
    <movable>true</movable>
    <perimeter>1</perimeter>
    <location-control>2</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-11-08T04:42:55.882723-08:00</update-date>
    </map-area>
    <update-date>2025-11-08T04:42:55.882723-08:00</update-date>
    <tags>
      <tag entity-id="sample string 1">
        <status>inactive</status>
      </tag>
      <tag entity-id="sample string 1">
        <status>inactive</status>
      </tag>
    </tags>
  </location>
</locations>

application/json, text/json

Sample:

{
  "locations": [
    {
      "parent-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "name": "sample string 1",
      "class": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "movable": true,
      "Perimeter": 1,
      "location-control": 2,
      "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-11-08T04:42:55.882723-08:00",
        "status": 0,
        "entity-id": "sample string 8"
      },
      "update-date": "2025-11-08T04:42:55.882723-08:00",
      "tags": [
        {
          "status": 0,
          "entity-id": "sample string 1"
        },
        {
          "status": 0,
          "entity-id": "sample string 1"
        }
      ],
      "status": 0,
      "entity-id": "sample string 4"
    },
    {
      "parent-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "name": "sample string 1",
      "class": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "movable": true,
      "Perimeter": 1,
      "location-control": 2,
      "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-11-08T04:42:55.882723-08:00",
        "status": 0,
        "entity-id": "sample string 8"
      },
      "update-date": "2025-11-08T04:42:55.882723-08:00",
      "tags": [
        {
          "status": 0,
          "entity-id": "sample string 1"
        },
        {
          "status": 0,
          "entity-id": "sample string 1"
        }
      ],
      "status": 0,
      "entity-id": "sample string 4"
    }
  ]
}