| All Verbs | /VerifyCredentials |
|---|
import Foundation
import ServiceStack
public class VerifyCredentials : ShowCommon
{
/**
* Operator ID
*/
// @ApiMember(Description="Operator ID", IsRequired=true)
public var operatorId:String
/**
* If set to true, any new badge scaned will create a new operator in the system.
*/
// @ApiMember(Description="If set to true, any new badge scaned will create a new operator in the system.")
public var createOperatorIfMissing:Bool?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case operatorId
case createOperatorIfMissing
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
operatorId = try container.decodeIfPresent(String.self, forKey: .operatorId)
createOperatorIfMissing = try container.decodeIfPresent(Bool.self, forKey: .createOperatorIfMissing)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if operatorId != nil { try container.encode(operatorId, forKey: .operatorId) }
if createOperatorIfMissing != nil { try container.encode(createOperatorIfMissing, forKey: .createOperatorIfMissing) }
}
}
public class ShowCommon : Codable
{
/**
* HTML Color code (e.g. FF00FF)
*/
// @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
public var color:String
/**
* 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 to show the position
*/
// @ApiMember(Description="Optional: name of the stockroom where to show the position")
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?
/**
* Optional: indicates if the header shall be displayed
*/
// @ApiMember(Description="Optional: indicates if the header shall be displayed")
public var displayHeader:Bool?
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /VerifyCredentials HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<VerifyCredentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Delay>0</Delay>
<DisplayHeader>false</DisplayHeader>
<Duration>0</Duration>
<Owner>String</Owner>
<Persistant>false</Persistant>
<StockroomName>String</StockroomName>
<Unreliable>false</Unreliable>
<CreateOperatorIfMissing>false</CreateOperatorIfMissing>
<OperatorId>String</OperatorId>
</VerifyCredentials>