Atrius developer portal

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.

DeleteKnownDevice

Delete a known device 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

https://api.us.atrius-iot.io/api/v2/admin/known-devices/{knownDeviceID}

Request parameters

knownDeviceID	integer	A unique numerical known device resource identifier.

Request headers

atr-partner-id	string	Vendor Supplied Partner ID
atr-request-source	string	String value representing userid or application name issuing the request
atr-environment-id	string	Environment in which to execute the request.
atr-subscription-key	string	A string identifier for authenticating subscription specific resources.

Request body

Response 204

Success

application/json

Response 400

Improper format for call.

application/json

{
  "msg": "Improper format for call.",
  "requestId": "e3c5ee48-2fa3-497f-ba5c-90f2357e49bd",
  "code": "BadRequest"
}

Response 401

Invalid Request.

application/json

Sample
Schema

{
  "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.

application/json

Sample
Schema

{
  "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 DELETE "https://api.us.atrius-iot.io/api/v2/admin/known-devices/{knownDeviceID}"
-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}");

            var uri = "https://api.us.atrius-iot.io/api/v2/admin/known-devices/{knownDeviceID}?" + queryString;

            var response = await client.DeleteAsync(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/{knownDeviceID}");


            URI uri = builder.build();
            HttpDelete request = new HttpDelete(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
        };
      
        $.ajax({
            url: "https://api.us.atrius-iot.io/api/v2/admin/known-devices/{knownDeviceID}?" + $.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: "DELETE",
            // 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/{knownDeviceID}";
    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:@"DELETE"];
    // 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/{knownDeviceID}');
$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
);

$url->setQueryVariables($parameters);

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

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

try:
    conn = httplib.HTTPSConnection('api.us.atrius-iot.io')
    conn.request("DELETE", "/api/v2/admin/known-devices/{knownDeviceID}?%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({
})

try:
    conn = http.client.HTTPSConnection('api.us.atrius-iot.io')
    conn.request("DELETE", "/api/v2/admin/known-devices/{knownDeviceID}?%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/{knownDeviceID}')


request = Net::HTTP::Delete.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