Home + Control

API change history

API to manage "Legrand/Bticino with Netatmo" products.

Set plug's status on ambient

Scopes: plug.write

Try it

Request URL

Request parameters

Name Type Description Values
plantId string

The plant to update

ambientId string

The ambient to update

Request headers

Name Type Description
Content-Type (optional) string Media type of the body sent to the API.
Ocp-Apim-Subscription-Key string Subscription key which provides access to this API. Found in your Profile.
Authorization string OAuth 2.0 access token obtained from OAuth Server for Try it Eliot API. Supported grant types: Authorization code.

Request body

The status to give to the plugs

{
  "status": "on"
}
{
  "type": "object",
  "properties": {
    "status": {
      "enum": [
        "on",
        "off"
      ],
      "type": "string"
    }
  }
}
{
  "status": "on"
}
{
  "type": "object",
  "properties": {
    "status": {
      "enum": [
        "on",
        "off"
      ],
      "type": "string"
    }
  }
}

Response 200

Plugs Status changed successfully

Response 400

Invalid arguments

{
  "errors": [
    {
      "userMessage": "string",
      "internalMessage": "string",
      "code": 0
    }
  ]
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userMessage": {
            "type": "string"
          },
          "internalMessage": {
            "type": "string"
          },
          "code": {
            "format": "int32",
            "type": "integer"
          }
        }
      }
    }
  }
}
{
  "errors": [
    {
      "userMessage": "string",
      "internalMessage": "string",
      "code": 0
    }
  ]
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userMessage": {
            "type": "string"
          },
          "internalMessage": {
            "type": "string"
          },
          "code": {
            "format": "int32",
            "type": "integer"
          }
        }
      }
    }
  }
}

Response 403

Operation forbidden

{
  "errors": [
    {
      "userMessage": "string",
      "internalMessage": "string",
      "code": 0
    }
  ]
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userMessage": {
            "type": "string"
          },
          "internalMessage": {
            "type": "string"
          },
          "code": {
            "format": "int32",
            "type": "integer"
          }
        }
      }
    }
  }
}
{
  "errors": [
    {
      "userMessage": "string",
      "internalMessage": "string",
      "code": 0
    }
  ]
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userMessage": {
            "type": "string"
          },
          "internalMessage": {
            "type": "string"
          },
          "code": {
            "format": "int32",
            "type": "integer"
          }
        }
      }
    }
  }
}

Response 404

Not found

{
  "errors": [
    {
      "userMessage": "string",
      "internalMessage": "string",
      "code": 0
    }
  ]
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userMessage": {
            "type": "string"
          },
          "internalMessage": {
            "type": "string"
          },
          "code": {
            "format": "int32",
            "type": "integer"
          }
        }
      }
    }
  }
}
{
  "errors": [
    {
      "userMessage": "string",
      "internalMessage": "string",
      "code": 0
    }
  ]
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userMessage": {
            "type": "string"
          },
          "internalMessage": {
            "type": "string"
          },
          "code": {
            "format": "int32",
            "type": "integer"
          }
        }
      }
    }
  }
}

Response 406

Request not acceptable

{
  "errors": [
    {
      "userMessage": "string",
      "internalMessage": "string",
      "code": 0
    }
  ]
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userMessage": {
            "type": "string"
          },
          "internalMessage": {
            "type": "string"
          },
          "code": {
            "format": "int32",
            "type": "integer"
          }
        }
      }
    }
  }
}
{
  "errors": [
    {
      "userMessage": "string",
      "internalMessage": "string",
      "code": 0
    }
  ]
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userMessage": {
            "type": "string"
          },
          "internalMessage": {
            "type": "string"
          },
          "code": {
            "format": "int32",
            "type": "integer"
          }
        }
      }
    }
  }
}

Response 500

Internal error

{
  "errors": [
    {
      "userMessage": "string",
      "internalMessage": "string",
      "code": 0
    }
  ]
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userMessage": {
            "type": "string"
          },
          "internalMessage": {
            "type": "string"
          },
          "code": {
            "format": "int32",
            "type": "integer"
          }
        }
      }
    }
  }
}
{
  "errors": [
    {
      "userMessage": "string",
      "internalMessage": "string",
      "code": 0
    }
  ]
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userMessage": {
            "type": "string"
          },
          "internalMessage": {
            "type": "string"
          },
          "code": {
            "format": "int32",
            "type": "integer"
          }
        }
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.developer.legrand.com/hc/api/v1.0/plug/energy/addressLocation/plants/{plantId}/ambients/parameter/id/value/{ambientId}"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access 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", "{access token}");

            var uri = "https://api.developer.legrand.com/hc/api/v1.0/plug/energy/addressLocation/plants/{plantId}/ambients/parameter/id/value/{ambientId}?" + 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.PostAsync(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.developer.legrand.com/hc/api/v1.0/plug/energy/addressLocation/plants/{plantId}/ambients/parameter/id/value/{ambientId}");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
            request.setHeader("Authorization", "{access 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/hc/api/v1.0/plug/energy/addressLocation/plants/{plantId}/ambients/parameter/id/value/{ambientId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            type: "POST",
            // 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/hc/api/v1.0/plug/energy/addressLocation/plants/{plantId}/ambients/parameter/id/value/{ambientId}";
    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:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    [_request setValue:@"{access 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/hc/api/v1.0/plug/energy/addressLocation/plants/{plantId}/ambients/parameter/id/value/{ambientId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
    'Authorization' => '{access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

// 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
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.developer.legrand.com')
    conn.request("POST", "/hc/api/v1.0/plug/energy/addressLocation/plants/{plantId}/ambients/parameter/id/value/{ambientId}?%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
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.developer.legrand.com')
    conn.request("POST", "/hc/api/v1.0/plug/energy/addressLocation/plants/{plantId}/ambients/parameter/id/value/{ambientId}?%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/hc/api/v1.0/plug/energy/addressLocation/plants/{plantId}/ambients/parameter/id/value/{ambientId}')

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access 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