| All Verbs | /ShowMultiple/{Keys}/{Color}/{Blink}/{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 ShowCommon 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 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 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")
/** @var string */
public string $Owner='',
/** @description 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)")
/** @var bool|null */
public ?bool $Unreliable=null,
/** @description Optional: indicates if the header shall be displayed */
// @ApiMember(Description="Optional: indicates if the header shall be displayed")
/** @var bool|null */
public ?bool $DisplayHeader=null
) {
}
/** @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['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'];
if (isset($o['Unreliable'])) $this->Unreliable = $o['Unreliable'];
if (isset($o['DisplayHeader'])) $this->DisplayHeader = $o['DisplayHeader'];
}
/** @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->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;
if (isset($this->Unreliable)) $o['Unreliable'] = $this->Unreliable;
if (isset($this->DisplayHeader)) $o['DisplayHeader'] = $this->DisplayHeader;
return empty($o) ? new class(){} : $o;
}
}
class ShowMultiple extends ShowCommon implements JsonSerializable
{
/**
* @param string $Color
* @param bool|null $Persistant
* @param int|null $Delay
* @param int|null $Duration
* @param string $StockroomName
* @param string $Owner
* @param bool|null $Unreliable
* @param bool|null $DisplayHeader
*/
public function __construct(
string $Color='',
?bool $Persistant=null,
?int $Delay=null,
?int $Duration=null,
string $StockroomName='',
string $Owner='',
?bool $Unreliable=null,
?bool $DisplayHeader=null,
/** @description Keys array identifying a location */
// @ApiMember(Description="Keys array identifying a location", IsRequired=true)
/** @var string[] */
public array $Keys=[],
/** @description Blinking or not */
// @ApiMember(Description="Blinking or not", IsRequired=true)
/** @var bool|null */
public ?bool $Blink=null
) {
parent::__construct($Color,$Persistant,$Delay,$Duration,$StockroomName,$Owner,$Unreliable,$DisplayHeader);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Keys'])) $this->Keys = JsonConverters::fromArray('string', $o['Keys']);
if (isset($o['Blink'])) $this->Blink = $o['Blink'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Keys)) $o['Keys'] = JsonConverters::toArray('string', $this->Keys);
if (isset($this->Blink)) $o['Blink'] = $this->Blink;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ShowMultiple/{Keys}/{Color}/{Blink}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Keys:
[
String
],
Blink: False,
Color: String,
Persistant: False,
Delay: 0,
Duration: 0,
StockroomName: String,
Owner: String,
Unreliable: False,
DisplayHeader: False
}