ZoneService

A list of all methods in the ZoneService service. Click on the method name to view detailed information about that method.

Methods	Description
GetZonesAsync	List all available zones
CreateZoneAsync	Create a new zone
GetZoneAsync	Get details of a single Zone from its given {zoneId}
UpdateZoneAsync	Update a single Zone from its given {zoneId}
DeleteZoneAsync	Delete a single Zone from its given {zoneId}

GetZonesAsync

List all available zones

• HTTP Method: GET
• Endpoint: /clip/v2/resource/zone

Return Type

GetZonesOkResponse

Example Usage Code Snippet

using OpenHue;

var client = new OpenHueClient();

var response = await client.Zone.GetZonesAsync();

Console.WriteLine(response);

CreateZoneAsync

Create a new zone

• HTTP Method: POST
• Endpoint: /clip/v2/resource/zone

Parameters

Name	Type	Required	Description
input	RoomPut	❌	The request body.

Return Type

CreateZoneOkResponse

Example Usage Code Snippet

using OpenHue;
using OpenHue.Models;

var client = new OpenHueClient();

var input = new RoomPut();

var response = await client.Zone.CreateZoneAsync(input);

Console.WriteLine(response);

GetZoneAsync

Get details of a single Zone from its given {zoneId}

• HTTP Method: GET
• Endpoint: /clip/v2/resource/zone/{zoneId}

Parameters

Name	Type	Required	Description
zoneId	string	✅	ID of the Zone

Return Type

GetZoneOkResponse

Example Usage Code Snippet

using OpenHue;

var client = new OpenHueClient();

var response = await client.Zone.GetZoneAsync("zoneId");

Console.WriteLine(response);

UpdateZoneAsync

Update a single Zone from its given {zoneId}

• HTTP Method: PUT
• Endpoint: /clip/v2/resource/zone/{zoneId}

Parameters

Name	Type	Required	Description
input	RoomPut	❌	The request body.
zoneId	string	✅	ID of the Zone

Return Type

UpdateZoneOkResponse

Example Usage Code Snippet

using OpenHue;
using OpenHue.Models;

var client = new OpenHueClient();

var input = new RoomPut();

var response = await client.Zone.UpdateZoneAsync(input, "zoneId");

Console.WriteLine(response);

DeleteZoneAsync

Delete a single Zone from its given {zoneId}

• HTTP Method: DELETE
• Endpoint: /clip/v2/resource/zone/{zoneId}

Parameters

Name	Type	Required	Description
zoneId	string	✅	ID of the Zone

Return Type

DeleteZoneOkResponse

Example Usage Code Snippet

using OpenHue;

var client = new OpenHueClient();

var response = await client.Zone.DeleteZoneAsync("zoneId");

Console.WriteLine(response);

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →