SSHost

<back to all web services

SetLightDimmingPlan

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/Gateway/SetLightDimmingPlan
SetLightDimmingPlan Parameters:
NameParameterData TypeRequiredDescription
PlanTypequerystringNo
DimmingPlanqueryList<DimmingPlanItem>No
DimmingPlanItem Parameters:
NameParameterData TypeRequiredDescription
GatewayIdformlongNo
LightIdformlongNo
DateTimeformDateTimeNo
DimmingValueformintNo
SetLightDimmingPlanResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Gateway/SetLightDimmingPlan HTTP/1.1 
Host: 188.68.237.94 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"PlanType":"String","DimmingPlan":[{"GatewayId":0,"LightId":0,"DateTime":"0001-01-01T00:00:00.0000000+01:00","DimmingValue":0}]}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

{"Status":"String"}