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

<back to all web services

PBL_SwitchOnPosition

Requires Authentication
The following routes are available for this service:
All Verbs/PBL_SwitchOnPosition
import Foundation
import ServiceStack

public class PBL_SwitchOnPosition : Codable
{
    /**
    * Position identifying a LED location
    */
    // @ApiMember(Description="Position identifying a LED location", IsRequired=true)
    public var position:String

    /**
    * Optional: Animated effect selection: 0 = Always ON (no effect, default), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW
    */
    // @ApiMember(Description="Optional: Animated effect selection: 0 = Always ON (no effect, default), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW")
    public var effect:Int?

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

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

    /**
    * 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: duration of the show in seconds
    */
    // @ApiMember(Description="Optional: duration of the show in seconds")
    public var duration:Int?

    required public init(){}
}

public class PBL_StandardResponse : Codable
{
    public var success:Bool
    public var error:String
    public var result:String
    public var color:String

    required public init(){}
}


Swift PBL_SwitchOnPosition 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 /PBL_SwitchOnPosition HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Position":"String","Effect":0,"Color":"String","HidePreviousPosition":false,"Owner":"String","Duration":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Success":false,"Error":"String","Result":{},"Color":"String"}