Admin Luminaire Positions (v1)

The Luminaire Positions API provides access to operations that retrieve and update luminaire positions.

PutLuminairePositionsSelfHealing

Save a list of lights map item resources, as output by the self healing process.

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 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.
(optional)

string

Media type of the body sent to the API.

string

A string identifier for authenticating subscription specific resources.

Request body

[
  {
    "LuminairePositionID": 1,
    "FloorSpace_ID": 1,
    "LuminaireNumber": 2,
    "X1": -8.737702,
    "X2": -8.737702,
    "X3": -8.966302,
    "Y1": -1.8288,
    "Y2": -3.048,
    "Y3": -3.048,
    "Z": 0,
    "LuminaireLabel": "Demo Luminaire",
    "FloorSpaceCatalog_ID": 1,
    "FlagNotes": "",
    "ControlGroup_ID": 1,
    "ExternalWidth": 2,
    "ExternalLength": 4,
    "VLCEnabled": true,
    "CICode": "000000",
    "LocationDescription": "Back Left Corner",
    "ReportingType": "cls",
    "LuminaireType_ID": "1",
    "LuminaireTypeDisplayName": "TestLuminaire",
    "VlcID": "2",
    "Code": [ 0, 2, 1, 3, 0, 3, 1 ],
    "PrimaryID": "9396569",
    "BeaconUUID": "2A9850C90F0B3A55",
    "FirmwareVersion": "3.93",
    "BootLoaderVersion": "255",
    "SoftDeviceVersion": "S130 v1.0",
    "Programmed": "true"
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "LuminairePositionID": {
        "type": "integer"
      },
      "FloorSpace_ID": {
        "type": "integer"
      },
      "LuminaireNumber": {
        "type": "integer"
      },
      "X1": {
        "type": "number"
      },
      "X2": {
        "type": "number"
      },
      "X3": {
        "type": "number"
      },
      "Y1": {
        "type": "number"
      },
      "Y2": {
        "type": "number"
      },
      "Y3": {
        "type": "number"
      },
      "Z": {
        "type": "integer"
      },
      "LuminaireLabel": {
        "type": "string"
      },
      "FloorSpaceCatalog_ID": {
        "type": "integer"
      },
      "FlagNotes": {
        "type": "string"
      },
      "ControlGroup_ID": {
        "type": "integer"
      },
      "ExternalWidth": {
        "type": "integer"
      },
      "ExternalLength": {
        "type": "integer"
      },
      "VLCEnabled": {
        "type": "boolean"
      },
      "CICode": {
        "type": "string"
      },
      "LocationDescription": {
        "type": "string"
      },
      "ReportingType": {
        "type": "string"
      },
      "LuminaireType_ID": {
        "type": "string"
      },
      "LuminaireTypeDisplayName": {
        "type": "string"
      },
      "VlcID": {
        "type": "string"
      },
      "Code": {
        "type": "array",
        "items": {
          "type": "integer"
        }
      },
      "PrimaryID": {
        "type": "string"
      },
      "BeaconUUID": {
        "type": "string"
      },
      "FirmwareVersion": {
        "type": "string"
      },
      "BootLoaderVersion": {
        "type": "string"
      },
      "SoftDeviceVersion": {
        "type": "string"
      },
      "Programmed": {
        "type": "string"
      }
    },
    "required": [
      "LuminairePositionID",
      "FloorSpace_ID",
      "LuminaireNumber",
      "X1",
      "X2",
      "X3",
      "Y1",
      "Y2",
      "Y3",
      "Z",
      "LuminaireLabel",
      "FloorSpaceCatalog_ID",
      "FlagNotes",
      "ControlGroup_ID",
      "ExternalWidth",
      "ExternalLength",
      "VLCEnabled",
      "CICode",
      "LocationDescription",
      "ReportingType",
      "LuminaireType_ID",
      "LuminaireTypeDisplayName",
      "VlcID",
      "Code",
      "PrimaryID",
      "BeaconUUID",
      "FirmwareVersion",
      "BootLoaderVersion",
      "SoftDeviceVersion",
      "Programmed"
    ]
  }
}

Response 200

Returns a collection of updated luminaire position resources. Note that this is not the same format as the request body.

{
  "result": [
    {
      "luminairePositionID": 1,
      "floorSpace_ID": 1,
      "luminaireNumber": 2,
      "X1": -8.737702,
      "X2": -8.737702,
      "X3": -8.966302,
      "Y1": -1.8288,
      "Y2": -3.048,
      "Y3": -3.048,
      "Z": 0,
      "luminaireLabel": "Demo Luminaire",
      "floorSpaceCatalog_ID": 1,
      "flagNotes": "",
      "controlGroup_ID": 1,
      "externalWidth": 2,
      "externalLength": 4,
      "VLCEnabled": true,
      "ciCode": "000000",
      "locationDescription": "Back Left Corner",
      "reportingType": "cls",
      "luminaireType_ID": "1",
      "luminaireTypeDisplayName": "TestLuminaire"
    }
  ],
  "count": 1,
  "limit": null,
  "offset": null
}
{
  "required": [
    "result",
    "count"
  ],
  "type": "object",
  "properties": {
    "result": {
      "description": "Array of Results",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "luminairePositionID": {
            "format": "int32",
            "type": "integer",
            "description": "A unique numerical identifier of the luminaire position resource"
          },
          "floorSpace_ID": {
            "format": "int32",
            "type": "integer",
            "description": "A numerical identifier that associates a luminaire position to a floor space resource"
          },
          "luminaireNumber": {
            "format": "int32",
            "type": "integer",
            "description": "VLC Identifier"
          },
          "X1": {
            "format": "double",
            "type": "number",
            "description": "X coordinate of the lower left corner of the luminaire"
          },
          "X2": {
            "format": "double",
            "type": "number",
            "description": "X coordinate of the upper left corner of the luminaire"
          },
          "X3": {
            "format": "double",
            "type": "number",
            "description": "X coordinate of the upper right corner of the luminaire"
          },
          "Y1": {
            "format": "double",
            "type": "number",
            "description": "Y coordinate of the lower left corner of the luminaire"
          },
          "Y2": {
            "format": "double",
            "type": "number",
            "description": "Y coordinate of the upper left corner of the luminaire"
          },
          "Y3": {
            "format": "double",
            "type": "number",
            "description": "Y coordinate of the upper right corner of the luminaire"
          },
          "Z": {
            "format": "double",
            "type": "number",
            "description": "Elevation of Luminaire"
          },
          "luminaireLabel": {
            "type": "string",
            "description": "Luminaire Label"
          },
          "floorSpaceCatalog_ID": {
            "format": "int32",
            "type": "integer",
            "description": "A numerical identifier that associates a luminaire position to a floor space catalog resource"
          },
          "flagNotes": {
            "type": "string",
            "description": "A place for commissioners to put notes about issues with luminaires that have been flagged as having issues"
          },
          "controlGroup_ID": {
            "format": "int32",
            "type": "integer",
            "description": "A numerical identifier that associates a luminaire position to a control group resource"
          },
          "externalWidth": {
            "format": "double",
            "type": "number",
            "description": "External Width (feet)"
          },
          "externalLength": {
            "format": "double",
            "type": "number",
            "description": "External Length (feet)"
          },
          "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,
          "floorSpace_ID": 1,
          "luminaireNumber": 2,
          "X1": -8.737702,
          "X2": -8.737702,
          "X3": -8.966302,
          "Y1": -1.8288,
          "Y2": -3.048,
          "Y3": -3.048,
          "Z": 0,
          "luminaireLabel": "Demo Luminaire",
          "floorSpaceCatalog_ID": 1,
          "flagNotes": "",
          "controlGroup_ID": 1,
          "externalWidth": 2,
          "externalLength": 4,
          "VLCEnabled": true,
          "ciCode": "SomeCode",
          "locationDescription": "SomeDescription",
          "reportingType": "0",
          "luminaireType_ID": "1",
          "luminaireTypeDisplayName": "TestLuminaire"
        }
      }
    },
    "count": {
      "format": "int32",
      "description": "The number of records in the response",
      "type": "integer"
    },
    "limit": {
      "format": "int32",
      "description": "The requested result limit",
      "type": "integer"
    },
    "offset": {
      "format": "int32",
      "description": "The requested number of skipped results",
      "type": "integer"
    }
  },
  "example": {
    "result": [
      {
        "luminairePositionID": 1,
        "floorSpace_ID": 1,
        "luminaireNumber": 2,
        "X1": -8.737702,
        "X2": -8.737702,
        "X3": -8.966302,
        "Y1": -1.8288,
        "Y2": -3.048,
        "Y3": -3.048,
        "Z": 0,
        "luminaireLabel": "Demo Luminaire",
        "floorSpaceCatalog_ID": 1,
        "flagNotes": "",
        "controlGroup_ID": 1,
        "externalWidth": 2,
        "externalLength": 4,
        "VLCEnabled": true,
        "ciCode": "000000",
        "locationDescription": "Back Left Corner",
        "reportingType": "cls",
        "luminaireType_ID": "1",
        "luminaireTypeDisplayName": "TestLuminaire"
      }
    ],
    "count": 1,
    "limit": null,
    "offset": null
  }
}

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 PUT "https://api.us.atrius-iot.io/api/v1/admin/luminaire-positions/self-healing"
-H "atr-environment-id: atrdemo01us"
-H "atr-partner-id: "
-H "atr-request-source: "
-H "Content-Type: application/json"
-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/luminaire-positions/self-healing?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
                content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
                response = await client.PutAsync(uri, content);
            }
        }
    }
}	
// // 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/luminaire-positions/self-healing");


            URI uri = builder.build();
            HttpPut request = new HttpPut(uri);
            request.setHeader("atr-environment-id", "atrdemo01us");
            request.setHeader("atr-partner-id", "");
            request.setHeader("atr-request-source", "");
            request.setHeader("Content-Type", "application/json");
            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/luminaire-positions/self-healing?" + $.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("Content-Type","application/json");
                xhrObj.setRequestHeader("atr-subscription-key","{subscription key}");
            },
            type: "PUT",
            // 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/luminaire-positions/self-healing";
    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:@"PUT"];
    // Request headers
    [_request setValue:@"atrdemo01us" forHTTPHeaderField:@"atr-environment-id"];
    [_request setValue:@"" forHTTPHeaderField:@"atr-partner-id"];
    [_request setValue:@"" forHTTPHeaderField:@"atr-request-source"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_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/luminaire-positions/self-healing');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'atr-environment-id' => 'atrdemo01us',
    'atr-partner-id' => '',
    'atr-request-source' => '',
    'Content-Type' => 'application/json',
    'atr-subscription-key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

// 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': '',
    'Content-Type': 'application/json',
    'atr-subscription-key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.us.atrius-iot.io')
    conn.request("PUT", "/api/v1/admin/luminaire-positions/self-healing?%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': '',
    'Content-Type': 'application/json',
    'atr-subscription-key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.us.atrius-iot.io')
    conn.request("PUT", "/api/v1/admin/luminaire-positions/self-healing?%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/luminaire-positions/self-healing')


request = Net::HTTP::Put.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['Content-Type'] = 'application/json'
# 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