Emergency Lighting API
API change history
Manage, control and monitor your emergency lighting installation remotely.
Get all controllers last status of a site
Get all controllers last status of a site.
Required scopes:
- safety.read
Try it
Request URL
Request parameters
Name | Type | Description | Values |
---|---|---|---|
siteId | string | Id site checked. |
Request headers
Name | Type | Description |
---|---|---|
Authorization | string | OpenID Connect Access Token obtained from ELIOT - Azure AD B2C. Supported grant types: Authorization code, Implicit. |
Ocp-Apim-Subscription-Key | string | Subscription key which provides access to this API. Found in your Profile. |
Authorization | string | OpenID Connect id token obtained from ELIOT - Azure AD B2C - OpenID Connect. Supported grant types: Authorization code, Implicit. |
Request body
Response 200
All site's controllers
[
{
"id": "string",
"name": "062520 @27.00.03",
"reference": "062520",
"serialNumber": "ELC_000474270003",
"lastStatusUpdate": "string",
"status": 0,
"failures": [
{
"flag": "string",
"failureType": "REMOTE.STATUS.NO_BLOCK_RESPONSE"
}
],
"alert": true,
"lastAlertUpdate": "string",
"alertLevel": 0
}
]
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Technical identifier (uuid) of controller",
"type": "string"
},
"name": {
"type": "string",
"example": "062520 @27.00.03"
},
"reference": {
"type": "string",
"example": "062520"
},
"serialNumber": {
"type": "string",
"example": "ELC_000474270003"
},
"lastStatusUpdate": {
"type": "string",
"format": "date-time",
"description": "Last status update of this controller"
},
"status": {
"type": "integer",
"description": "Status code of this controller"
},
"failures": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flag": {
"description": "Failure flag in hexadecimal",
"type": "string"
},
"failureType": {
"type": "string",
"enum": [
"BLOCK.OK",
"BLOCK.FAULTY_COMMUNICATION",
"BLOCK.OTHER_FAULTY",
"BLOCK.ALARM_STATE",
"BLOCK.DLD",
"BLOCK.FAULTY_POWER_SUPPLY",
"BLOCK.FAULTY_BATTERY",
"BLOCK.DISCONNECTED_BATTERY",
"BLOCK.FAULTY_EMERGENCY_LIGHT",
"BLOCK.FAULTY_ELECTRONICAL",
"REMOTE.STATUS.OK",
"REMOTE.STATUS.SECTOR_ON_BUS",
"REMOTE.STATUS.BUS_SHORT_CIRCUIT",
"REMOTE.STATUS.NO_BLOCK_RESPONSE",
"REMOTE.STATUS.CAPACITY_OVERFLOW",
"REMOTE.STATUS.NFC_COMM_FAULT",
"REMOTE.STATUS.QUARTZ_FAULT",
"REMOTE.STATUS.BATTERY_FAULT",
"REMOTE.STATUS.BLOCK_ENROLLMENT_FAULT",
"REMOTE.STATUS.ELECTRONIC_FAULT",
"REMOTE.STATUS.OUT_SUPERVISION"
],
"example": "REMOTE.STATUS.NO_BLOCK_RESPONSE"
}
}
},
"description": "Failures related to controller."
},
"alert": {
"type": "boolean",
"description": "Specify if controller is whether or not in alert"
},
"lastAlertUpdate": {
"type": "string",
"format": "date-time",
"description": "Last alert update of this controller"
},
"alertLevel": {
"type": "integer",
"description": "Number of units in failure before controller is reported in alert"
}
}
}
}
Response 204
Site has no controller yet.
Response 400
Bad input parameter
Response 401
Supplied access token is invalid or doesn't include required scope(s).
Code samples
@ECHO OFF
curl -v -X GET "https://api.developer.legrand.com/baes/sites/{siteId}/elc"
-H "Authorization: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {id token}"
--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("Authorization", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
client.DefaultRequestHeaders.Add("Authorization", "{id token}");
var uri = "https://api.developer.legrand.com/baes/sites/{siteId}/elc?" + 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.developer.legrand.com/baes/sites/{siteId}/elc");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Authorization", "");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
request.setHeader("Authorization", "{id token}");
// 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.developer.legrand.com/baes/sites/{siteId}/elc?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","{id token}");
},
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.developer.legrand.com/baes/sites/{siteId}/elc";
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:@"" forHTTPHeaderField:@"Authorization"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
[_request setValue:@"{id token}" forHTTPHeaderField:@"Authorization"];
// 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.developer.legrand.com/baes/sites/{siteId}/elc');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
'Authorization' => '{id token}',
);
$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
'Authorization': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
'Authorization': '{id token}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.developer.legrand.com')
conn.request("GET", "/baes/sites/{siteId}/elc?%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
'Authorization': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
'Authorization': '{id token}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.developer.legrand.com')
conn.request("GET", "/baes/sites/{siteId}/elc?%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.developer.legrand.com/baes/sites/{siteId}/elc')
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{id token}'
# 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