Classe 300X13E - V2.0
API change history
An API to easily get informations and control your Classe 300 X13E. To use it, please install Door Entry SDK
Call home
Operation used to retrieve the JWT ticket required to call home through SDK.
Required scope: audiovideoterminal.read
Try itRequest URL
Request parameters
Name | Type | Description | Values |
---|---|---|---|
plantId | string | Format - uuid. The id of the plant |
|
deviceId | string | Format - uuid. The id of the device |
Request headers
Name | Type | Description |
---|---|---|
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
OK
{
"audiovideounits": [
{
"ticket": "string",
"sender": {
"addressType": "addressLocation",
"system": "videodoorentry",
"plant": {
"id": "string"
}
}
}
]
}
{
"type": "object",
"properties": {
"audiovideounits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ticket": {
"type": "string",
"format": "JWT",
"description": "Ticket to call home"
},
"sender": {
"type": "object",
"description": "Sender of the message",
"properties": {
"addressType": {
"type": "string",
"enum": [
"addressLocation"
]
},
"system": {
"type": "string",
"enum": [
"videodoorentry"
]
},
"plant": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The id of the plant"
}
}
}
}
}
}
}
}
}
}
Response 400
Bad request: something is probably wrong in your request body or headers.
{
"statusCode": 400,
"message": "Bad request"
}
{
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 400,
"description": "Error code"
},
"message": {
"type": "string",
"example": "Bad request",
"description": "Error message"
}
}
}
Response 401
Unauthorized: user is not authorized to access the requested resource.
{
"statusCode": 401,
"message": "Unauthorized"
}
{
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401,
"description": "Error code"
},
"message": {
"type": "string",
"example": "Unauthorized",
"description": "Error message"
}
}
}
Response 404
Resource not found: something is probably wrong in your request URL.
{
"statusCode": 404,
"message": "Resource not found"
}
{
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404,
"description": "Error code"
},
"message": {
"type": "string",
"example": "Resource not found",
"description": "Error message"
}
}
}
Response 408
Request timeout
{
"statusCode": 408,
"message": "Request timeout"
}
{
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 408,
"description": "Error code"
},
"message": {
"type": "string",
"example": "Request timeout",
"description": "Error message"
}
}
}
Response 500
Server internal error
{
"statusCode": 500,
"message": "Server internal error"
}
{
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 500,
"description": "Error code"
},
"message": {
"type": "string",
"example": "Server internal error",
"description": "Error message"
}
}
}
Code samples
@ECHO OFF
curl -v -X GET "https://api.developer.legrand.com/classe300x13e/v2.0/audiovideounit/videodoorentry/addressLocation/plants/{plantId}/modules/parameter/id/value/{deviceId}/callIn"
-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("Ocp-Apim-Subscription-Key", "{subscription key}");
client.DefaultRequestHeaders.Add("Authorization", "{id token}");
var uri = "https://api.developer.legrand.com/classe300x13e/v2.0/audiovideounit/videodoorentry/addressLocation/plants/{plantId}/modules/parameter/id/value/{deviceId}/callIn?" + 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/classe300x13e/v2.0/audiovideounit/videodoorentry/addressLocation/plants/{plantId}/modules/parameter/id/value/{deviceId}/callIn");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
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/classe300x13e/v2.0/audiovideounit/videodoorentry/addressLocation/plants/{plantId}/modules/parameter/id/value/{deviceId}/callIn?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
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/classe300x13e/v2.0/audiovideounit/videodoorentry/addressLocation/plants/{plantId}/modules/parameter/id/value/{deviceId}/callIn";
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:@"{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/classe300x13e/v2.0/audiovideounit/videodoorentry/addressLocation/plants/{plantId}/modules/parameter/id/value/{deviceId}/callIn');
$url = $request->getUrl();
$headers = array(
// Request headers
'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
'Ocp-Apim-Subscription-Key': '{subscription key}',
'Authorization': '{id token}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.developer.legrand.com')
conn.request("GET", "/classe300x13e/v2.0/audiovideounit/videodoorentry/addressLocation/plants/{plantId}/modules/parameter/id/value/{deviceId}/callIn?%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
'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", "/classe300x13e/v2.0/audiovideounit/videodoorentry/addressLocation/plants/{plantId}/modules/parameter/id/value/{deviceId}/callIn?%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/classe300x13e/v2.0/audiovideounit/videodoorentry/addressLocation/plants/{plantId}/modules/parameter/id/value/{deviceId}/callIn')
request = Net::HTTP::Get.new(uri.request_uri)
# 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