| All Verbs | /ShowMultipleEx/{Color}/{Persistant} |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class KeyToDisplay implements JsonSerializable
{
public function __construct(
/** @description Key identifying a location */
// @ApiMember(Description="Key identifying a location", IsRequired=true)
/** @var string */
public string $Key='',
/** @description Blinking or not */
// @ApiMember(Description="Blinking or not", IsRequired=true)
/** @var bool|null */
public ?bool $Blink=null,
/** @description Indicates whether we show the area header of the blinking key or not */
// @ApiMember(Description="Indicates whether we show the area header of the blinking key or not", IsRequired=true)
/** @var bool|null */
public ?bool $ShowHeader=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Key'])) $this->Key = $o['Key'];
if (isset($o['Blink'])) $this->Blink = $o['Blink'];
if (isset($o['ShowHeader'])) $this->ShowHeader = $o['ShowHeader'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Key)) $o['Key'] = $this->Key;
if (isset($this->Blink)) $o['Blink'] = $this->Blink;
if (isset($this->ShowHeader)) $o['ShowHeader'] = $this->ShowHeader;
return empty($o) ? new class(){} : $o;
}
}
class ShowMultipleEx implements JsonSerializable
{
public function __construct(
/** @description HTML Color code (e.g. FF00FF) */
// @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
/** @var string */
public string $Color='',
/** @description 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)
/** @var bool|null */
public ?bool $Persistant=null,
/** @description List of key object (KeyToDisplay) to display */
// @ApiMember(Description="List of key object (KeyToDisplay) to display", IsRequired=true)
/** @var array<KeyToDisplay>|null */
public ?array $Keys=null,
/** @description Optional: delay the execution of the command (in seconds) */
// @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
/** @var int|null */
public ?int $Delay=null,
/** @description Optional: duration of the show in seconds */
// @ApiMember(Description="Optional: duration of the show in seconds")
/** @var int|null */
public ?int $Duration=null,
/** @description Optional: name of the stockroom where to show the position */
// @ApiMember(Description="Optional: name of the stockroom where to show the position")
/** @var string */
public string $StockroomName='',
/** @description Name of the owner of the color/command to allow color sharing */
// @ApiMember(Description="Name of the owner of the color/command to allow color sharing")
/** @var string */
public string $Owner=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Color'])) $this->Color = $o['Color'];
if (isset($o['Persistant'])) $this->Persistant = $o['Persistant'];
if (isset($o['Keys'])) $this->Keys = JsonConverters::fromArray('KeyToDisplay', $o['Keys']);
if (isset($o['Delay'])) $this->Delay = $o['Delay'];
if (isset($o['Duration'])) $this->Duration = $o['Duration'];
if (isset($o['StockroomName'])) $this->StockroomName = $o['StockroomName'];
if (isset($o['Owner'])) $this->Owner = $o['Owner'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Color)) $o['Color'] = $this->Color;
if (isset($this->Persistant)) $o['Persistant'] = $this->Persistant;
if (isset($this->Keys)) $o['Keys'] = JsonConverters::toArray('KeyToDisplay', $this->Keys);
if (isset($this->Delay)) $o['Delay'] = $this->Delay;
if (isset($this->Duration)) $o['Duration'] = $this->Duration;
if (isset($this->StockroomName)) $o['StockroomName'] = $this->StockroomName;
if (isset($this->Owner)) $o['Owner'] = $this->Owner;
return empty($o) ? new class(){} : $o;
}
}
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 /ShowMultipleEx/{Color}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowMultipleEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Delay>0</Delay>
<Duration>0</Duration>
<Keys>
<KeyToDisplay>
<Blink>false</Blink>
<Key>String</Key>
<ShowHeader>false</ShowHeader>
</KeyToDisplay>
</Keys>
<Owner>String</Owner>
<Persistant>false</Persistant>
<StockroomName>String</StockroomName>
</ShowMultipleEx>