Admin Sites (v1)

The Sites API provides access to create, read and update site resources. Sites resources are a key element of the organizational hierarchy. A site resource is a discrete location in the world. It can be composed of one (retail store) or more buildings (college campus). Configuration and metric calculations are tied directly to the site configuration.

GetSitesById

Retrieve a single site resource.

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 unique numerical identifier of the site resource.

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 site resource.

{
  "siteID": 1,
  "organization_ID": 1,
  "siteName": "Demo site",
  "businessAddress_ID": 1,
  "serviceStatus": "ACTIVE",
  "timezoneID": 1,
  "fromGeometri": false,
  "active": true,
  "lumicastConfigTag": "",
  "swCornerLatitude": 33.679309457918,
  "swCornerLongitude": -84.044262170791,
  "neCornerLatitude": 33.682813645533,
  "neCornerLongitude": -84.039101600646,
  "centroidLatitude": 33.6810615517255,
  "centroidLongitude": -84.0416818857185,
  "networkAnalystURL": "http://navigator-mapserver-103.acuitynext.io/arcgis/rest/services/acuity/Routes/NAServer/Route",
  "image": null,
  "mobileSiteOptions": {
    "fallbackMilliseconds": 5000,
    "transmitFrequencyMilliseconds": 1000,
    "alwaysTransmitBLELocationCaptureWhenAvailable": true,
    "writeToEventHub": true,
    "millisecondsBetweenLocationCapture": 500,
    "useAdvertiserIdAsDeviceId": true,
    "useConfigCacheDuringNetworkUnavailability": true
  },
  "floorSpaceJsonC2DEnabled": true,
  "controlGroupsJsonD2CEnabled": true
}
{
  "type": "object",
  "properties": {
    "siteID": {
      "format": "int32",
      "description": "A unique numerical identifier of the site resource",
      "type": "integer"
    },
    "organization_ID": {
      "format": "int32",
      "description": "A numerical identifier that associates a site to an organization resource",
      "type": "integer"
    },
    "siteName": {
      "description": "User friendly name for site",
      "type": "string"
    },
    "businessAddress_ID": {
      "format": "int32",
      "description": "A numerical identifier that associates a site to a business address resource",
      "type": "integer"
    },
    "serviceStatus": {
      "description": "Defines service status of positioning. (ACTIVE, INACTIVE)",
      "type": "string"
    },
    "timezoneID": {
      "format": "int32",
      "description": "Time Zone Identifier as defined in https://msdn.microsoft.com/en-us/library/gg154758.aspx",
      "type": "integer"
    },
    "fromGeometri": {
      "description": "Defines if input data originates from geometri",
      "type": "boolean"
    },
    "active": {
      "description": "Flag defining active status",
      "type": "boolean"
    },
    "lumicastConfigTag": {
      "description": "Tag for initializing the Qualcomm SDK on Mobile devices",
      "type": "string"
    },
    "swCornerLatitude": {
      "format": "double",
      "description": " Latitude of South West Corner in WGS84 ",
      "type": "number"
    },
    "swCornerLongitude": {
      "format": "double",
      "description": " Longitude of South West Corner in WGS84 ",
      "type": "number"
    },
    "neCornerLatitude": {
      "format": "double",
      "description": " Latitude of North East Corner in WGS84 ",
      "type": "number"
    },
    "neCornerLongitude": {
      "format": "double",
      "description": " Longitude of North East Corner in WGS84 ",
      "type": "number"
    },
    "centroidLatitude": {
      "format": "double",
      "description": "Latitude of Centroid of the site in WGS84",
      "type": "number"
    },
    "centroidLongitude": {
      "format": "double",
      "description": "Longitude of Centroid of the site in WGS84",
      "type": "number"
    },
    "networkAnalystURL": {
      "description": "Provides routing service URL at site level",
      "type": "string"
    },
    "image": {
      "description": "URL of Site Image",
      "type": "string"
    },
    "mobileSiteOptions": {
      "type": "object",
      "properties": {
        "fallbackMilliseconds": {
          "format": "int32",
          "description": "Default timer value in milliseconds for site",
          "type": "integer"
        },
        "millisecondsBetweenLocationCapture": {
          "format": "int32",
          "description": "Time in milliseconds between position capture for site",
          "type": "integer"
        },
        "transmitFrequencyMilliseconds": {
          "format": "int32",
          "description": "Time between data transmissions for site",
          "type": "integer"
        },
        "useConfigCacheDuringNetworkUnavailability": {
          "type": "boolean",
          "description": "Whether or not to use config cache when network connection unavilable for site"
        },
        "writeToEventHub": {
          "type": "boolean",
          "description": "Whether caller should send data to Event Hub for site"
        },
        "alwaysTransmitBLELocationCaptureWhenAvailable": {
          "type": "boolean",
          "description": "whether or not to transmit location via BLE when available for site"
        },
        "useAdvertiserIdAsDeviceId": {
          "type": "boolean",
          "description": "A unique numerical identifier of the useAdvertiserIdAsDeviceId resource"
        }
      },
      "example": {
        "fallbackMilliseconds": 5000,
        "millisecondsBetweenLocationCapture": 500,
        "transmitFrequencyMilliseconds": 1000,
        "useConfigCacheDuringNetworkUnavailability": true,
        "writeToEventHub": true,
        "alwaysTransmitBLELocationCaptureWhenAvailable": true,
        "useAdvertiserIdAsDeviceId": true
      }
    },
    "floorSpaceJsonC2DEnabled": {
      "description": "Flag that controls transmission of the FloorSpace JSON to controllers associated with the site",
      "type": "boolean"
    },
    "controlGroupsJsonD2CEnabled": {
      "description": "Flag that controls receipt of Control Groups JSON by cloud services",
      "type": "boolean"
    }
  },
  "example": {
    "siteID": 1,
    "organization_ID": 1,
    "siteName": "Demo site",
    "businessAddress_ID": 1,
    "serviceStatus": "ACTIVE",
    "timezoneID": 1,
    "fromGeometri": false,
    "active": true,
    "lumicastConfigTag": "",
    "swCornerLatitude": 33.679309457918,
    "swCornerLongitude": -84.044262170791,
    "neCornerLatitude": 33.682813645533,
    "neCornerLongitude": -84.039101600646,
    "centroidLatitude": 33.6810615517255,
    "centroidLongitude": -84.0416818857185,
    "networkAnalystURL": "http://navigator-mapserver-103.acuitynext.io/arcgis/rest/services/acuity/Routes/NAServer/Route",
    "image": null,
    "mobileSiteOptions": {
      "fallbackMilliseconds": 5000,
      "transmitFrequencyMilliseconds": 1000,
      "alwaysTransmitBLELocationCaptureWhenAvailable": true,
      "writeToEventHub": true,
      "millisecondsBetweenLocationCapture": 500,
      "useAdvertiserIdAsDeviceId": true,
      "useConfigCacheDuringNetworkUnavailability": true
    },
    "floorSpaceJsonC2DEnabled": true,
    "controlGroupsJsonD2CEnabled": true
  }
}

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/sites/{siteId}"
-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}");

            var uri = "https://api.us.atrius-iot.io/api/v1/admin/sites/{siteId}?" + 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/sites/{siteId}");


            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
        };
      
        $.ajax({
            url: "https://api.us.atrius-iot.io/api/v1/admin/sites/{siteId}?" + $.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/sites/{siteId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    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/sites/{siteId}');
$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
);

$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({
})

try:
    conn = httplib.HTTPSConnection('api.us.atrius-iot.io')
    conn.request("GET", "/api/v1/admin/sites/{siteId}?%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({
})

try:
    conn = http.client.HTTPSConnection('api.us.atrius-iot.io')
    conn.request("GET", "/api/v1/admin/sites/{siteId}?%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/sites/{siteId}')


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