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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<SetLightDimmingPlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <DimmingPlan>
    <DimmingPlanItem>
      <DateTime>0001-01-01T00:00:00</DateTime>
      <DimmingValue>0</DimmingValue>
      <GatewayId>0</GatewayId>
      <LightId>0</LightId>
    </DimmingPlanItem>
  </DimmingPlan>
  <PlanType>String</PlanType>
</SetLightDimmingPlan>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SetLightDimmingPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Status>String</Status>
</SetLightDimmingPlanResponse>