Admin Known Devices (v2)
The Asset Known Device API provides access to create, read and update known device resources. Known Devices resources connect a known entity like a person or asset to one or more devices. A known device id is added to a position object as the position streams through the system. A known device can be associated with a single physical device with multiple ids (wifi, bluetooth, and/or bls) or can be associated with multiple physical devices. In addition, known devices can be assigned categories.
GetKnownDevicesByCategoryID
Retrieve a list of known device resources for a given category.
Test Route
Try itNote: 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 category identifier to retrieve known device resources associated with the category. |
|
(optional) | string |
A flag for filtering by active status. |
(optional) | string |
A flag for filtering by device type. |
Request headers
string |
Vendor Supplied Partner ID |
|
string |
String value representing userid or application name issuing the request |
|
string |
Environment in which to execute the request. |
|
string |
A string identifier for authenticating subscription specific resources. |
Request body
Response 200
Returns a collection of known device resources.
{
"result": [
{
"knownDeviceID": 1,
"site_ID": 1,
"profile_ID": 1,
"profileName": "Example Profile",
"deviceID": "66d8f89d-da1a-4fd9-80fc-1332d87078a8",
"active": true,
"name": "High Value Item",
"description": "This beacon is associated with a high value item in the store.",
"displayIcon": "f0d6",
"alwaysPresent": true,
"deviceType": "Beacon",
"categories": [
{
"categoryID": 1,
"organization_ID": 1,
"categoryName": "Cannot Leave Store",
"active": true,
"displayIcon": "f1b2",
"description": "An asset that should never leave the store"
}
],
"optionalProperties": [
{
"knownDeviceOptionalPropertyID": 1,
"key": "manufacturer",
"value": "Acuity Brands Lighting, inc.",
"propertyType": {
"propertyTypeID": 1,
"name": "string"
}
}
]
},
{
"knownDeviceID": 1,
"site_ID": 1,
"profile_ID": 1,
"profileName": "Example Profile",
"deviceID": "dd3f589b-c155-4cd1-baba-edccda11adf8",
"active": true,
"name": "Sales Person",
"description": "This phone is associated with a sales person on the floor.",
"displayIcon": "f007",
"alwaysPresent": true,
"deviceType": "Phone",
"categories": [
{
"categoryID": 2,
"organization_ID": 1,
"categoryName": "Associate",
"active": true,
"displayIcon": "f0c0",
"description": "An asset assigned with an associate"
}
],
"optionalProperties": [
{
"knownDeviceOptionalPropertyID": 1,
"key": "manufacturer",
"value": "Acuity Brands Lighting, inc.",
"propertyType": {
"propertyTypeID": 1,
"name": "string"
}
}
]
}
],
"count": 2
}
{
"required": [
"result",
"count"
],
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"knownDeviceID",
"site_ID",
"active"
],
"type": "object",
"properties": {
"knownDeviceID": {
"format": "int32",
"description": "A unique numerical identifier of the known device resource",
"type": "integer"
},
"site_ID": {
"format": "int32",
"description": "A numerical identifier that associates a known device resource to a site resource",
"type": "integer"
},
"deviceID": {
"format": "string",
"description": "A unique identifier for the physical hardware"
},
"active": {
"description": "Flag defining active status",
"type": "boolean"
},
"name": {
"description": "A descriptive name for the known device",
"type": "string"
},
"description": {
"description": "Additional information describing the known device",
"type": "string"
},
"displayIcon": {
"description": "Display Icon unicode string, URI or class for the visual representation of the category",
"type": "string"
},
"deviceType": {
"description": "Enum defining the device type of the resulting object",
"enum": [
"Phone",
"Beacon"
],
"type": "string"
},
"categories": {
"description": "Array of Known Device Categories associated with a known device",
"type": "array",
"items": {
"required": [
"categoryID",
"organization_ID",
"categoryName",
"active"
],
"type": "object",
"properties": {
"categoryID": {
"format": "int32",
"type": "integer"
},
"organization_ID": {
"format": "int32",
"type": "integer"
},
"categoryName": {
"type": "string"
},
"active": {
"type": "boolean"
}
}
}
},
"optionalProperties": {
"description": "Array of optional ad-hoc properties",
"type": "array",
"items": {
"required": [
"knownDeviceOptionalPropertyID",
"key",
"value",
"propertyType"
],
"type": "object",
"properties": {
"knownDeviceOptionalPropertyID": {
"format": "int32",
"type": "integer"
},
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"propertyType": {
"required": [
"propertyTypeID",
"name"
],
"type": "object",
"properties": {
"propertyTypeID": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
}
}
}
}
}
}
}
}
},
"count": {
"format": "int32",
"type": "integer"
},
"limit": {
"format": "int32",
"type": "integer"
},
"offset": {
"format": "int32",
"type": "integer"
}
}
}
Response 400
Improper format for call.
{
"msg": "Improper format for call.",
"requestId": "e3c5ee48-2fa3-497f-ba5c-90f2357e49bd",
"code": "BadRequest"
}
Response 401
Invalid Request.
{
"msg": "Unauthorized to access this resource.",
"requestId": "e3c5ee48-2fa3-497f-ba5c-90f2357e49bd",
"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": "e3c5ee48-2fa3-497f-ba5c-90f2357e49bd",
"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/v2/admin/known-devices/category-id/{categoryID}?active={string}&device-type={string}"
-H "atr-partner-id: "
-H "atr-request-source: "
-H "atr-environment-id: atrdemo01us"
-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-partner-id", "");
client.DefaultRequestHeaders.Add("atr-request-source", "");
client.DefaultRequestHeaders.Add("atr-environment-id", "atrdemo01us");
client.DefaultRequestHeaders.Add("atr-subscription-key", "{subscription key}");
// Request parameters
queryString["active"] = "{string}";
queryString["device-type"] = "{string}";
var uri = "https://api.us.atrius-iot.io/api/v2/admin/known-devices/category-id/{categoryID}?" + 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/v2/admin/known-devices/category-id/{categoryID}");
builder.setParameter("active", "{string}");
builder.setParameter("device-type", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("atr-partner-id", "");
request.setHeader("atr-request-source", "");
request.setHeader("atr-environment-id", "atrdemo01us");
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": "{string}",
"device-type": "{string}",
};
$.ajax({
url: "https://api.us.atrius-iot.io/api/v2/admin/known-devices/category-id/{categoryID}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("atr-partner-id","");
xhrObj.setRequestHeader("atr-request-source","");
xhrObj.setRequestHeader("atr-environment-id","atrdemo01us");
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/v2/admin/known-devices/category-id/{categoryID}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"active={string}",
@"device-type={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"atr-partner-id"];
[_request setValue:@"" forHTTPHeaderField:@"atr-request-source"];
[_request setValue:@"atrdemo01us" forHTTPHeaderField:@"atr-environment-id"];
[_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/v2/admin/known-devices/category-id/{categoryID}');
$url = $request->getUrl();
$headers = array(
// Request headers
'atr-partner-id' => '',
'atr-request-source' => '',
'atr-environment-id' => 'atrdemo01us',
'atr-subscription-key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'active' => '{string}',
'device-type' => '{string}',
);
$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-partner-id': '',
'atr-request-source': '',
'atr-environment-id': 'atrdemo01us',
'atr-subscription-key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'active': '{string}',
'device-type': '{string}',
})
try:
conn = httplib.HTTPSConnection('api.us.atrius-iot.io')
conn.request("GET", "/api/v2/admin/known-devices/category-id/{categoryID}?%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-partner-id': '',
'atr-request-source': '',
'atr-environment-id': 'atrdemo01us',
'atr-subscription-key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'active': '{string}',
'device-type': '{string}',
})
try:
conn = http.client.HTTPSConnection('api.us.atrius-iot.io')
conn.request("GET", "/api/v2/admin/known-devices/category-id/{categoryID}?%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/v2/admin/known-devices/category-id/{categoryID}')
query = URI.encode_www_form({
# Request parameters
'active' => '{string}',
'device-type' => '{string}'
})
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-partner-id'] = ''
# Request headers
request['atr-request-source'] = ''
# Request headers
request['atr-environment-id'] = 'atrdemo01us'
# 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