Admin Lights Map (v1)
The Lights Map API provides access to operations to retrieve the current lights map for an Eclypse Controller.
GetLightsMapForControllerDeviceID
Retrieves the lights map for the supplied Eclypse Controller Device ID.
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
string |
An Eclypse controller's device ID, e.g. ECYS1000-SOMEECLY-PSE0-DEVI-CEID-STRING012345 |
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 CollectionDataEnvelope of LightsMapItems.
{
"result": [
{
"LuminairePositionID": 1,
"FloorSpace_ID": 1,
"X1": -8.737702,
"X2": -8.737702,
"X3": -8.966302,
"Y1": -1.8288,
"Y2": -3.048,
"Y3": -3.048,
"Z": 1.5,
"ControlGroup_ID": "1",
"ExternalWidth": "150.5",
"ExternalLength": "150.5",
"VLCEnabled": true,
"FloorSpaceCatalog_ID": 1,
"VlcID": 2,
"Code": [ 0, 2, 1, 3, 0, 3, 1 ],
"PrimaryID": "9396569",
"BeaconUUID": "2A9850C90F0B3A55",
"FirmwareVersion": "3.93",
"BootLoaderVersion": "255",
"SoftDeviceVersion": "S130 v1.0",
"LuminaireNumber": "2",
"LuminaireLabel": "Demo Luminaire",
"FlagNotes": "",
"Programmed": "true",
"CICode": "001122",
"LocationDescription": "Back Left Corner",
"ReportingType": "null",
"LuminaireType_ID": "null",
"LuminaireTypeDisplayName": "string"
}
],
"count": 1,
"limit": "null",
"offset": "null"
}
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"LuminairePositionID": {
"type": "integer"
},
"FloorSpace_ID": {
"type": "integer"
},
"X1": {
"type": "number"
},
"X2": {
"type": "number"
},
"X3": {
"type": "number"
},
"Y1": {
"type": "number"
},
"Y2": {
"type": "number"
},
"Y3": {
"type": "number"
},
"Z": {
"type": "number"
},
"ControlGroup_ID": {
"type": "string"
},
"ExternalWidth": {
"type": "string"
},
"ExternalLength": {
"type": "string"
},
"VLCEnabled": {
"type": "boolean"
},
"FloorSpaceCatalog_ID": {
"type": "integer"
},
"VlcID": {
"type": "integer"
},
"Code": {
"type": "array",
"items": {
"type": "integer"
}
},
"PrimaryID": {
"type": "string"
},
"BeaconUUID": {
"type": "string"
},
"FirmwareVersion": {
"type": "string"
},
"BootLoaderVersion": {
"type": "string"
},
"SoftDeviceVersion": {
"type": "string"
},
"LuminaireNumber": {
"type": "string"
},
"LuminaireLabel": {
"type": "string"
},
"FlagNotes": {
"type": "string"
},
"Programmed": {
"type": "string"
},
"CICode": {
"type": "string"
},
"LocationDescription": {
"type": "string"
},
"ReportingType": {
"type": "string"
},
"LuminaireType_ID": {
"type": "string"
},
"LuminaireTypeDisplayName": {
"type": "string"
}
},
"required": [
"LuminairePositionID",
"FloorSpace_ID",
"X1",
"X2",
"X3",
"Y1",
"Y2",
"Y3",
"Z",
"ControlGroup_ID",
"ExternalWidth",
"ExternalLength",
"VLCEnabled",
"FloorSpaceCatalog_ID",
"VlcID",
"Code",
"PrimaryID",
"BeaconUUID",
"FirmwareVersion",
"BootLoaderVersion",
"SoftDeviceVersion",
"LuminaireNumber",
"LuminaireLabel",
"FlagNotes",
"Programmed",
"CICode",
"LocationDescription",
"ReportingType",
"LuminaireType_ID",
"LuminaireTypeDisplayName"
]
}
},
"count": {
"type": "integer"
},
"limit": {
"type": "string"
},
"offset": {
"type": "string"
}
}
}
Response 400
Invalid Request.
{
"msg": "Improper format for call.",
"requestId": "273e4bb4-3019-42ea-8de9-f2c7853f7fdd",
"code": "BadRequest"
}
{
"type": "object",
"properties": {
"msg": {
"type": "string"
},
"requestId": {
"type": "string"
},
"code": {
"type": "string"
}
}
}
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": {
"type": "string"
},
"requestId": {
"type": "string"
},
"code": {
"type": "string"
}
}
}
Response 404
Resource Not Found.
{
"msg": "The resource requested was not found.",
"requestId": "b9ff87b2-3397-45f7-a0b6-25482b0a7898",
"code": "NotFound"
}
{
"type": "object",
"properties": {
"msg": {
"type": "string"
},
"requestId": {
"type": "string"
},
"code": {
"type": "string"
}
}
}
Code samples
@ECHO OFF
curl -v -X GET "https://api.us.atrius-iot.io/api/v1/admin/lights-map/controller-device-id/{controllerDeviceID}"
-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/lights-map/controller-device-id/{controllerDeviceID}?" + 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/lights-map/controller-device-id/{controllerDeviceID}");
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/lights-map/controller-device-id/{controllerDeviceID}?" + $.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/lights-map/controller-device-id/{controllerDeviceID}";
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/lights-map/controller-device-id/{controllerDeviceID}');
$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/lights-map/controller-device-id/{controllerDeviceID}?%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/lights-map/controller-device-id/{controllerDeviceID}?%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/lights-map/controller-device-id/{controllerDeviceID}')
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