Go-to-Light Service 4.0.0.2397 - 121 - API License to Cloud Demo

<back to all web services

ShowArea

Requires Authentication
The following routes are available for this service:
All Verbs/ShowArea/{AreaID}/{ColorStart}/{ColorStop}/{Duration}
import Foundation
import ServiceStack

public class ShowArea : Codable
{
    /**
    * Area ID
    */
    // @ApiMember(Description="Area ID", IsRequired=true)
    public var areaID:Int

    /**
    * HTML Color code (e.g. FF00FF) of the first pixel
    */
    // @ApiMember(Description="HTML Color code (e.g. FF00FF) of the first pixel", IsRequired=true)
    public var colorStart:String

    /**
    * HTML Color code (e.g. FF00FF) of the last pixel
    */
    // @ApiMember(Description="HTML Color code (e.g. FF00FF) of the last pixel", IsRequired=true)
    public var colorStop:String

    /**
    * Duration in seconds
    */
    // @ApiMember(Description="Duration in seconds", IsRequired=true)
    public var duration:Int

    /**
    * Optional: name of the owner of the color/command to allow color sharing
    */
    // @ApiMember(Description="Optional: name of the owner of the color/command to allow color sharing")
    public var owner:String

    required public init(){}
}


Swift ShowArea DTOs

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

HTTP + CSV

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

POST /ShowArea/{AreaID}/{ColorStart}/{ColorStop}/{Duration} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"AreaID":0,"ColorStart":"String","ColorStop":"String","Duration":0,"Owner":"String"}