Admin Control Groups (v1)

The Admin Control Groups API provides access to create, read and update control group resources.

GetControlsGroupsWithLuminaireSummariesByFloorSpaceId

Retrieve Lights JSON For Distech Eclypse Controller Ordered In Control Group Order With Coordinates Transformed Using Floor Space Settings And Offsets and Converted To Positive Values In Pixels.

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 floor space resource identifier.

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 distech eclypse header resource.

{
  "retailerAPIKey": "string",
  "dehDTO": {
    "siteID": 1,
    "siteName": "Demo site",
    "floorSpaceID": 1,
    "floorSpaceName": "string",
    "proximityUUID": 1,
    "vlcEnabled": false,
    "floorGroups": []
  }
}
{
  "type": "object",
  "properties": {
    "retailerAPIKey": {
      "type": "string",
      "description": "Retailer API Key"
    },
    "dehDTO": {
      "type": "object",
      "properties": {
        "siteID": {
          "format": "int32",
          "type": "integer",
          "description": "A unique numerical identifier of the site resource"
        },
        "siteName": {
          "type": "string",
          "description": "Site Name"
        },
        "floorSpaceID": {
          "format": "int32",
          "type": "integer",
          "description": "Floor Space Identifier"
        },
        "floorSpaceName": {
          "type": "string",
          "description": "Floor Space Name"
        },
        "proximityUUID": {
          "type": "string",
          "description": "Proximity UUID"
        },
        "vlcEnabled": {
          "type": "boolean",
          "description": "VLC Enabled/Disabled Flag"
        },
        "floorGroups": {
          "type": "array",
          "description": "Array of Floor Groups",
          "items": {
            "type": "object",
            "properties": {
              "groupID": {
                "format": "int32",
                "type": "integer",
                "description": "A unique numerical identifier of the group resource"
              },
              "groupName": {
                "type": "string",
                "description": "Group Name"
              },
              "color": {
                "type": "string",
                "description": "Controller Color"
              },
              "masterHostID": {
                "type": "string",
                "description": "Master Host Identifier GUID"
              },
              "region": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "path": {
                      "type": "array",
                      "description": "Array of Group Paths",
                      "items": {
                        "type": "object",
                        "properties": {
                          "x": {
                            "format": "double",
                            "type": "number",
                            "description": "X Coordinate"
                          },
                          "y": {
                            "format": "double",
                            "type": "number",
                            "description": "Y Coordinate"
                          }
                        },
                        "example": {
                          "x": 0,
                          "y": 0
                        }
                      }
                    }
                  },
                  "example": {
                    "path": [
                      {
                        "x": 0,
                        "y": 0
                      }
                    ]
                  }
                },
                "description": "Region Array"
              },
              "luminaires": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "luminairePositionID": {
                      "format": "int32",
                      "type": "integer",
                      "description": "A unique numerical identifier of the luminaire position resource"
                    },
                    "vlcID": {
                      "format": "int32",
                      "type": "integer",
                      "description": "VLC Identifier"
                    },
                    "code": {
                      "type": "array",
                      "description": "Array of Luminaire Codes",
                      "items": {
                        "format": "int32",
                        "type": "integer",
                        "description": "Luminaire Code"
                      }
                    },
                    "primaryID": {
                      "format": "int32",
                      "type": "integer",
                      "description": "Primary Identifier"
                    },
                    "beaconUUID": {
                      "type": "string",
                      "description": "Beacon UUID"
                    },
                    "luminaireLabel": {
                      "type": "string",
                      "description": "Label"
                    },
                    "luminaireLabelValue": {
                      "format": "int32",
                      "type": "integer",
                      "description": "Label Value"
                    },
                    "path": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "x": {
                            "format": "double",
                            "type": "number",
                            "description": "X Coordinate"
                          },
                          "y": {
                            "format": "double",
                            "type": "number",
                            "description": "Y Coordinate"
                          },
                          "z": {
                            "format": "double",
                            "type": "number",
                            "description": "Z Coordinate"
                          }
                        },
                        "example": {
                          "x": 0,
                          "y": 0,
                          "z": 10
                        }
                      },
                      "description": "Array of Luminaire Paths"
                    },
                    "VLCEnabled": {
                      "type": "boolean",
                      "description": "VLC Enabled/Disabled Flag"
                    },
                    "ciCode": {
                      "type": "string",
                      "description": "Luminaire Model Number"
                    },
                    "locationDescription": {
                      "type": "string",
                      "description": "Description of the location of Luminaire within the site"
                    },
                    "reportingType": {
                      "type": "string",
                      "description": "Reporting type"
                    },
                    "luminaireType_ID": {
                      "format": "int32",
                      "type": "integer",
                      "description": "FK to Luminaire Type"
                    },
                    "luminaireTypeDisplayName": {
                      "type": "string",
                      "description": "Luminaire Type Name"
                    }
                  },
                  "example": {
                    "luminairePositionID": 1,
                    "vlcID": 1,
                    "code": [
                      0
                    ],
                    "primaryID": 1,
                    "beaconUUID": 1,
                    "luminaireLabel": 0,
                    "luminaireLabelValue": 0,
                    "path": [
                      {
                        "x": 0,
                        "y": 0,
                        "z": 10
                      }
                    ],
                    "VLCEnabled": true,
                    "ciCode": "000000",
                    "locationDescription": "Back Left Corner",
                    "reportingType": "cls",
                    "luminaireType_ID": "1",
                    "luminaireTypeDisplayName": "TestLuminaire"
                  }
                },
                "description": "Luminaire Array"
              }
            },
            "example": {
              "groupID": 1,
              "groupName": "Demo group",
              "color": "#FF0000",
              "masterHostID": 1,
              "region": [
                {
                  "x": 0,
                  "y": 0
                }
              ],
              "luminaires": [
                {
                  "luminairePositionID": 1,
                  "vlcID": 1,
                  "code": [
                    0
                  ],
                  "primaryID": 1,
                  "beaconUUID": 1,
                  "luminaireLabel": "Demo Luminaire",
                  "luminaireLabelValue": 0,
                  "path": [
                    {
                      "x": 0,
                      "y": 0,
                      "z": 10
                    }
                  ],
                  "VLCEnabled": true,
                  "ciCode": "000000",
                  "locationDescription": "Back Left Corner",
                  "reportingType": "cls",
                  "luminaireType_ID": "1",
                  "luminaireTypeDisplayName": "TestLuminaire"
                }
              ]
            }
          }
        }
      },
      "example": {
        "siteID": 1,
        "siteName": "Demo site",
        "floorSpaceID": 1,
        "floorSpaceName": "string",
        "proximityUUID": 1,
        "vlcEnabled": false,
        "floorGroups": [
          {
            "groupID": 1,
            "groupName": "Demo group",
            "color": "string",
            "masterHostID": 1,
            "region": [
              {
                "x": 0,
                "y": 0
              }
            ],
            "luminaires": [
              {
                "luminairePositionID": 1,
                "vlcID": 1,
                "code": [
                  0
                ],
                "primaryID": 1,
                "beaconUUID": 1,
                "luminaireLabel": 0,
                "luminaireLabelValue": 0,
                "path": [
                  {
                    "x": 0,
                    "y": 0,
                    "z": 10
                  }
                ],
                "VLCEnabled": true,
                "ciCode": "000000",
                "locationDescription": "Back Left Corner",
                "reportingType": "cls",
                "luminaireType_ID": "1",
                "luminaireTypeDisplayName": "TestLuminaire"
              }
            ]
          }
        ]
      },
      "description": "Distech Eclypse Header Object"
    }
  },
  "example": {
    "retailerAPIKey": "string",
    "dehDTO": {
      "siteID": 1,
      "siteName": "Demo site",
      "floorSpaceID": 1,
      "floorSpaceName": "string",
      "proximityUUID": 1,
      "vlcEnabled": false,
      "floorGroups": []
    }
  }
}

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/control-groups/with-luminaire-summary-by-floor-space-id/{floorSpaceId}"
-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/control-groups/with-luminaire-summary-by-floor-space-id/{floorSpaceId}?" + 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/control-groups/with-luminaire-summary-by-floor-space-id/{floorSpaceId}");


            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/control-groups/with-luminaire-summary-by-floor-space-id/{floorSpaceId}?" + $.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/control-groups/with-luminaire-summary-by-floor-space-id/{floorSpaceId}";
    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/control-groups/with-luminaire-summary-by-floor-space-id/{floorSpaceId}');
$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/control-groups/with-luminaire-summary-by-floor-space-id/{floorSpaceId}?%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/control-groups/with-luminaire-summary-by-floor-space-id/{floorSpaceId}?%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/control-groups/with-luminaire-summary-by-floor-space-id/{floorSpaceId}')


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