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

<back to all web services

ShowOnLedController

Requires Authentication
The following routes are available for this service:
All Verbs/ShowOnLedController/{LCAddress}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant}
import Foundation
import ServiceStack

public class ShowOnLedController : Codable
{
    /**
    * Led Controller Address
    */
    // @ApiMember(Description="Led Controller Address", IsRequired=true)
    public var lcAddress:String

    /**
    * HTML Color code (e.g. FF00FF)
    */
    // @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
    public var color:String

    /**
    * Pixel number
    */
    // @ApiMember(Description="Pixel number", IsRequired=true)
    public var pixel:Int

    /**
    * Pixel width
    */
    // @ApiMember(Description="Pixel width", IsRequired=true)
    public var width:Int

    /**
    * Blinking or not
    */
    // @ApiMember(Description="Blinking or not", IsRequired=true)
    public var blink:Bool

    /**
    * When set to false, it turns off the same color in a previous position
    */
    // @ApiMember(Description="When set to false, it turns off the same color in a previous position", IsRequired=true)
    public var persistant:Bool

    /**
    * Optional: delay the execution of the command (in seconds)
    */
    // @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
    public var delay:Int?

    /**
    * Optional: duration of the show in seconds
    */
    // @ApiMember(Description="Optional: duration of the show in seconds")
    public var duration:Int?

    /**
    * Optional: name of the stockroom where the area is located
    */
    // @ApiMember(Description="Optional: name of the stockroom where the area is located")
    public var stockroomName:String

    /**
    * 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

    /**
    * Optional: indicates if message shall be delivered in an unreliable way (faster)
    */
    // @ApiMember(Description="Optional: indicates if message shall be delivered in an unreliable way (faster)")
    public var unreliable:Bool?

    required public init(){}
}


Swift ShowOnLedController DTOs

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

HTTP + OTHER

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

POST /ShowOnLedController/{LCAddress}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"LCAddress":"String","Color":"String","Pixel":0,"Width":0,"Blink":false,"Persistant":false,"Delay":0,"Duration":0,"StockroomName":"String","Owner":"String","Unreliable":false}