POST api/v2/locations
Create new location
Request Information
URI Parameters
None.
Body Parameters
Location object
Location| Name | Description | Type | Additional information |
|---|---|---|---|
| parent-location |
Parent location |
LocationSimple |
None. |
| name |
Name of location |
string |
Required |
| description |
Location description |
string |
None. |
| class |
Location class |
LocationClassSimple |
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. |
| tags |
All tags value associated with the location |
Collection of TagSimple |
None. |
| status |
Status (active or not) |
TagvueEntityStatus |
None. |
| entity-id |
Identifying entity-id of the entity, this is expected to be unique |
string |
None. |
Request Formats
application/xml, text/xml
Sample:
<location entity-id="sample string 4" 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 2">
<name>sample string 1</name>
</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-11-08T04:37:26.6884241-08:00</update-date>
</map-area>
<tags>
<tag entity-id="sample string 1">
<status>inactive</status>
</tag>
<tag entity-id="sample string 1">
<status>inactive</status>
</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": {
"name": "sample string 1",
"entity-id": "sample string 2"
},
"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-11-08T04:37:26.6884241-08:00",
"status": 0,
"entity-id": "sample string 8"
},
"tags": [
{
"status": 0,
"entity-id": "sample string 1"
},
{
"status": 0,
"entity-id": "sample string 1"
}
],
"status": 0,
"entity-id": "sample string 4"
}
Response Information
Resource Description
Returns CREATED (201) if operation was succesfull or BAD REQUEST (400) if received object is invalid
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |