Admin Zones (v1)

The Zone API provides access to create, read and update zone resources. Zones represent physical areas on a floor where positions are collected and metrics are processed. A position must exist in a zone in order for it to be collected by the system. Zones are represented as GeoJSON features.

There are three types of zones:

  • Capture Area (multi-floor | site optional) - Represent the maximum bounds for collecting positions. Any positions identified as outside of the capture area are dropped from the system.
  • Metric (site required) - Represent areas for position and metric collection. The collection of zone represent a site metric.
  • Action (site optional) - Represent areas on the floor where client actions should occur. The messageContent is open for client applications to store application specific content.

GetZonesByBuildingId

Retrieve a list of zone resources for a given building.

Test Route

Try it

Note: When you click on the Try It button you may see the following warning message: "" You can ignore this warning message and proceed by entering appropriate values for any query parameters and required header values.

Request URL

Request parameters

integer

A numerical building identifier to retrieve zone associated with the building.
(optional)

string

Filter by active state.

Request headers

string

Environment in which to execute the request.

string

A GUID identifier for requesting partner specific resources.

string

String value representing userid or application name issuing the request.

string

A string identifier for authenticating subscription specific resources.

Request body

Response 200

Returns a collection of zone resources.

{
  "result": [
    {
      "type": "Feature",
      "properties": {
        "zoneID": 1,
        "site_ID": 1,
        "floor_ID": 1,
        "dwellTriggerMS": 0,
        "name": "Demo zone",
        "enterTrigger": true,
        "exitTrigger": true,
        "zoneType": "ActionZone",
        "messageContent": {
          "description": "Org 1 Primary Key",
          "title": "You entered the zone!"
        },
        "hoursOfOperation": {},
        "active": true
      },
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              40.1894099,
              -77.2334465
            ],
            [
              40.1911071,
              -77.234697
            ],
            [
              40.1913009,
              -77.2334161
            ],
            [
              40.1894099,
              -77.2334465
            ]
          ]
        ]
      }
    }
  ],
  "count": 1,
  "limit": null,
  "offset": null
}
{
  "required": [
    "result",
    "count"
  ],
  "type": "object",
  "properties": {
    "result": {
      "description": "Array of Results",
      "type": "array",
      "items": {
        "required": [
          "properties",
          "geometry"
        ],
        "type": "object",
        "properties": {
          "type": {
            "description": "GeoJSON Type. This value should always be Feature.",
            "type": "string"
          },
          "properties": {
            "required": [
              "site_ID",
              "name",
              "zoneType"
            ],
            "type": "object",
            "properties": {
              "zoneID": {
                "format": "int32",
                "description": "A unique numerical identifier of the zone resource",
                "type": "integer"
              },
              "site_ID": {
                "format": "int32",
                "description": "A numerical identifier that associates a zone to a site resource",
                "type": "integer"
              },
              "floor_ID": {
                "format": "int32",
                "description": "A numerical identifier that associates a zone to a floor resource",
                "type": "integer"
              },
              "name": {
                "description": "The name of a zone",
                "type": "string"
              },
              "zoneType": {
                "description": "Zone Type: Pick from MetricZone (Areas we will calculate metrics), CaptureArea (Max extent of position captures), or ActionZone (Area for client defined actions)",
                "type": "string"
              },
              "enterTrigger": {
                "description": "Trigger client action upon entering zone (ActionZone)",
                "type": "boolean"
              },
              "exitTrigger": {
                "description": "Trigger client action upon exiting zone (ActionZone)",
                "type": "boolean"
              },
              "dwellTriggerMS": {
                "format": "int32",
                "description": "Trigger client action after dwelling for a number of milliseconds (ActionZone)",
                "type": "integer"
              },
              "messageContent": {
                "description": "Client defined data zone (ActionZone)",
                "type": "string"
              },
              "hoursOfOperation": {
                "type": "string",
                "description": "Client defined Hours Of Operation for zone"
              },
              "active": {
                "type": "boolean",
                "description": "Defines whether record is active"
              }
            },
            "example": {
              "zoneID": 1,
              "site_ID": 1,
              "floor_ID": 1,
              "name": "Demo Action Zone",
              "zoneType": "ActionZone",
              "enterTrigger": true,
              "exitTrigger": true,
              "dwellTriggerMS": 0,
              "messageContent": {
                "description": "This is client defined information. The client can decide to use this information when the user enters the zone.",
                "title": "You entered the zone!"
              },
              "hoursOfOperation": {},
              "active": 1
            }
          },
          "geometry": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "description": "GeoJSON geometry type"
              },
              "coordinates": {
                "description": "GeoJSON coordinates",
                "type": "array",
                "items": {
                  "type": "array",
                  "items": {
                    "format": "double",
                    "type": "number"
                  }
                }
              }
            },
            "example": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    40.1894099,
                    -77.2334465
                  ],
                  [
                    40.1911071,
                    -77.234697
                  ],
                  [
                    40.1913009,
                    -77.2334161
                  ],
                  [
                    40.1894099,
                    -77.2334465
                  ]
                ]
              ]
            }
          }
        },
        "example": {
          "type": "Feature",
          "properties": {
            "zoneID": 1,
            "site_ID": 1,
            "floor_ID": 1,
            "dwellTriggerMS": 0,
            "name": "Demo Action Zone",
            "enterTrigger": true,
            "exitTrigger": true,
            "zoneType": "ActionZone",
            "messageContent": {
              "description": "This is client defined information. The client can decide to use this information when the user enters the zone.",
              "title": "You entered the zone!"
            },
            "hoursOfOperation": {},
            "active": true
          },
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  40.1894099,
                  -77.2334465
                ],
                [
                  40.1911071,
                  -77.234697
                ],
                [
                  40.1913009,
                  -77.2334161
                ],
                [
                  40.1894099,
                  -77.2334465
                ]
              ]
            ]
          }
        }
      }
    },
    "count": {
      "format": "int32",
      "description": "The number of records in the response",
      "type": "integer"
    },
    "limit": {
      "format": "int32",
      "description": "The requested result limit",
      "type": "integer"
    },
    "offset": {
      "format": "int32",
      "description": "The requested number of skipped results",
      "type": "integer"
    }
  },
  "example": {
    "result": [
      {
        "type": "Feature",
        "properties": {
          "zoneID": 1,
          "site_ID": 1,
          "floor_ID": 1,
          "dwellTriggerMS": 0,
          "name": "Demo zone",
          "enterTrigger": true,
          "exitTrigger": true,
          "zoneType": "ActionZone",
          "messageContent": {
            "description": "Org 1 Primary Key",
            "title": "You entered the zone!"
          },
          "hoursOfOperation": {},
          "active": true
        },
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                40.1894099,
                -77.2334465
              ],
              [
                40.1911071,
                -77.234697
              ],
              [
                40.1913009,
                -77.2334161
              ],
              [
                40.1894099,
                -77.2334465
              ]
            ]
          ]
        }
      }
    ],
    "count": 1,
    "limit": null,
    "offset": null
  }
}

Response 400

Invalid Request.

{
  "msg": "Improper format for call.",
  "requestId": "273e4bb4-3019-42ea-8de9-f2c7853f7fdd",
  "code": "BadRequest"
}
{
  "type": "object",
  "properties": {
    "msg": {
      "description": "A descriptive message detailing the cause of the error",
      "type": "string"
    },
    "requestId": {
      "description": "A unique GUID identifier for the request",
      "type": "string"
    },
    "code": {
      "description": "A textual representation of the error code",
      "type": "string"
    }
  },
  "example": {
    "msg": "A descriptive message detailing the cause of the error",
    "requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
    "code": "ErrorCode"
  }
}

Response 401

Not Authorized To Access This Resource.

{
  "msg": "Unauthorized to access this resource.",
  "requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
  "code": "Unauthorized"
}
{
  "type": "object",
  "properties": {
    "msg": {
      "description": "A descriptive message detailing the cause of the error",
      "type": "string"
    },
    "requestId": {
      "description": "A unique GUID identifier for the request",
      "type": "string"
    },
    "code": {
      "description": "A textual representation of the error code",
      "type": "string"
    }
  },
  "example": {
    "msg": "A descriptive message detailing the cause of the error",
    "requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
    "code": "ErrorCode"
  }
}

Response 404

Resource Not Found.

{
  "msg": "The resource requested was not found.",
  "requestId": "b9ff87b2-3397-45f7-a0b6-25482b0a7898",
  "code": "NotFound"
}
{
  "type": "object",
  "properties": {
    "msg": {
      "description": "A descriptive message detailing the cause of the error",
      "type": "string"
    },
    "requestId": {
      "description": "A unique GUID identifier for the request",
      "type": "string"
    },
    "code": {
      "description": "A textual representation of the error code",
      "type": "string"
    }
  },
  "example": {
    "msg": "A descriptive message detailing the cause of the error",
    "requestId": "2269623a-af6a-419f-b15b-2c8391b50149",
    "code": "ErrorCode"
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.us.atrius-iot.io/api/v1/admin/zones/building-id/{buildingId}?active=active"
-H "atr-environment-id: atrdemo01us"
-H "atr-partner-id: "
-H "atr-request-source: "
-H "atr-subscription-key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("atr-environment-id", "atrdemo01us");
            client.DefaultRequestHeaders.Add("atr-partner-id", "");
            client.DefaultRequestHeaders.Add("atr-request-source", "");
            client.DefaultRequestHeaders.Add("atr-subscription-key", "{subscription key}");

            // Request parameters
            queryString["active"] = "active";
            var uri = "https://api.us.atrius-iot.io/api/v1/admin/zones/building-id/{buildingId}?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.us.atrius-iot.io/api/v1/admin/zones/building-id/{buildingId}");

            builder.setParameter("active", "active");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("atr-environment-id", "atrdemo01us");
            request.setHeader("atr-partner-id", "");
            request.setHeader("atr-request-source", "");
            request.setHeader("atr-subscription-key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "active": "active",
        };
      
        $.ajax({
            url: "https://api.us.atrius-iot.io/api/v1/admin/zones/building-id/{buildingId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("atr-environment-id","atrdemo01us");
                xhrObj.setRequestHeader("atr-partner-id","");
                xhrObj.setRequestHeader("atr-request-source","");
                xhrObj.setRequestHeader("atr-subscription-key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.us.atrius-iot.io/api/v1/admin/zones/building-id/{buildingId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"active=active",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"atrdemo01us" forHTTPHeaderField:@"atr-environment-id"];
    [_request setValue:@"" forHTTPHeaderField:@"atr-partner-id"];
    [_request setValue:@"" forHTTPHeaderField:@"atr-request-source"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"atr-subscription-key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.us.atrius-iot.io/api/v1/admin/zones/building-id/{buildingId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'atr-environment-id' => 'atrdemo01us',
    'atr-partner-id' => '',
    'atr-request-source' => '',
    'atr-subscription-key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'active' => 'active',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'atr-environment-id': 'atrdemo01us',
    'atr-partner-id': '',
    'atr-request-source': '',
    'atr-subscription-key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'active': 'active',
})

try:
    conn = httplib.HTTPSConnection('api.us.atrius-iot.io')
    conn.request("GET", "/api/v1/admin/zones/building-id/{buildingId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'atr-environment-id': 'atrdemo01us',
    'atr-partner-id': '',
    'atr-request-source': '',
    'atr-subscription-key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'active': 'active',
})

try:
    conn = http.client.HTTPSConnection('api.us.atrius-iot.io')
    conn.request("GET", "/api/v1/admin/zones/building-id/{buildingId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.us.atrius-iot.io/api/v1/admin/zones/building-id/{buildingId}')

query = URI.encode_www_form({
    # Request parameters
    'active' => 'active'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['atr-environment-id'] = 'atrdemo01us'
# Request headers
request['atr-partner-id'] = ''
# Request headers
request['atr-request-source'] = ''
# Request headers
request['atr-subscription-key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body