GET api/v2/locations/classes

Get all location classes

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Location classes list

LocationClassList

Name	Description	Type	Additional information
location-classes	List of locations classes	Collection of LocationClassDetails	None.

Response Formats

application/xml, text/xml

Sample:

<location-classes xmlns="urn:tagvue:am">
  <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>
  <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>
</location-classes>

application/json, text/json

Sample:

{
  "location-classes": [
    {
      "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"
    },
    {
      "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"
    }
  ]
}