| All Verbs | /PBL_SwitchOnPositions |
|---|
<?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 PBL_SwitchOnPositions implements JsonSerializable
{
public function __construct(
/** @description List of position identifying LED locations */
// @ApiMember(Description="List of position identifying LED locations", IsRequired=true)
/** @var array<string>|null */
public ?array $Positions=null,
/** @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 */
// @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")
/** @var int|null */
public ?int $Effect=null,
/** @description Optional: HTML Color code (e.g. FF00FF) */
// @ApiMember(Description="Optional: HTML Color code (e.g. FF00FF)")
/** @var string */
public string $Color='',
/** @description 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")
/** @var bool|null */
public ?bool $HidePreviousPosition=null,
/** @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=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Positions'])) $this->Positions = JsonConverters::fromArray('string', $o['Positions']);
if (isset($o['Effect'])) $this->Effect = $o['Effect'];
if (isset($o['Color'])) $this->Color = $o['Color'];
if (isset($o['HidePreviousPosition'])) $this->HidePreviousPosition = $o['HidePreviousPosition'];
if (isset($o['Owner'])) $this->Owner = $o['Owner'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Positions)) $o['Positions'] = JsonConverters::toArray('string', $this->Positions);
if (isset($this->Effect)) $o['Effect'] = $this->Effect;
if (isset($this->Color)) $o['Color'] = $this->Color;
if (isset($this->HidePreviousPosition)) $o['HidePreviousPosition'] = $this->HidePreviousPosition;
if (isset($this->Owner)) $o['Owner'] = $this->Owner;
return empty($o) ? new class(){} : $o;
}
}
class PBL_StandardResponse implements JsonSerializable
{
public function __construct(
/** @var bool|null */
public ?bool $Success=null,
/** @var string */
public string $Error='',
/** @var Object|null */
public ?Object $Result=null,
/** @var string */
public string $Color=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Success'])) $this->Success = $o['Success'];
if (isset($o['Error'])) $this->Error = $o['Error'];
if (isset($o['Result'])) $this->Result = JsonConverters::from('Object', $o['Result']);
if (isset($o['Color'])) $this->Color = $o['Color'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Success)) $o['Success'] = $this->Success;
if (isset($this->Error)) $o['Error'] = $this->Error;
if (isset($this->Result)) $o['Result'] = JsonConverters::to('Object', $this->Result);
if (isset($this->Color)) $o['Color'] = $this->Color;
return empty($o) ? new class(){} : $o;
}
}
PHP PBL_SwitchOnPositions DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /PBL_SwitchOnPositions HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Positions":["String"],"Effect":0,"Color":"String","HidePreviousPosition":false,"Owner":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Success":false,"Error":"String","Result":{},"Color":"String"}