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

<back to all web services

PBL_SwitchOffPosition

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

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

    /**
    * Optional: HTML Color code (e.g. FF00FF)
    */
    // @ApiMember(Description="Optional: HTML Color code (e.g. FF00FF)")
    public var color: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: set paramter to TRUE if you need to turn off any color previously turned ON at specified position
    */
    // @ApiMember(Description="Optional: set paramter to TRUE if you need to turn off any color previously turned ON at specified position")
    public var switchOffAnyColor:Bool?

    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_SwitchOffPosition 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 /PBL_SwitchOffPosition HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Position":"String","Color":"String","Owner":"String","SwitchOffAnyColor":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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