| All Verbs | /ShowPredictive/{BlinkKey}/{SteadyKey}/{Color}/{ShowHeader}/{Owner} |
|---|
<?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};
enum HeaderMode : string
{
case on = 'on';
case off = 'off';
case once = 'once';
}
class ShowPredictive implements JsonSerializable
{
public function __construct(
/** @description Key identifying a location that will be shown blinking */
// @ApiMember(Description="Key identifying a location that will be shown blinking", IsRequired=true)
/** @var string */
public string $BlinkKey='',
/** @description Key identifying a location that will be shown not blinking */
// @ApiMember(Description="Key identifying a location that will be shown not blinking", IsRequired=true)
/** @var string */
public string $SteadyKey='',
/** @description HTML Color code (e.g. FF00FF) */
// @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
/** @var string */
public string $Color='',
/** @description Indicates the way the area header will be displayed (possible values are on, off, once) */
// @ApiMember(Description="Indicates the way the area header will be displayed (possible values are on, off, once)", IsRequired=true)
/** @var HeaderMode|null */
public ?HeaderMode $ShowHeader=null,
/** @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", IsRequired=true)
/** @var string */
public string $Owner='',
/** @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=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['BlinkKey'])) $this->BlinkKey = $o['BlinkKey'];
if (isset($o['SteadyKey'])) $this->SteadyKey = $o['SteadyKey'];
if (isset($o['Color'])) $this->Color = $o['Color'];
if (isset($o['ShowHeader'])) $this->ShowHeader = JsonConverters::from('HeaderMode', $o['ShowHeader']);
if (isset($o['Owner'])) $this->Owner = $o['Owner'];
if (isset($o['StockroomName'])) $this->StockroomName = $o['StockroomName'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->BlinkKey)) $o['BlinkKey'] = $this->BlinkKey;
if (isset($this->SteadyKey)) $o['SteadyKey'] = $this->SteadyKey;
if (isset($this->Color)) $o['Color'] = $this->Color;
if (isset($this->ShowHeader)) $o['ShowHeader'] = JsonConverters::to('HeaderMode', $this->ShowHeader);
if (isset($this->Owner)) $o['Owner'] = $this->Owner;
if (isset($this->StockroomName)) $o['StockroomName'] = $this->StockroomName;
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 /ShowPredictive/{BlinkKey}/{SteadyKey}/{Color}/{ShowHeader}/{Owner} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowPredictive xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<BlinkKey>String</BlinkKey>
<Color>String</Color>
<Owner>String</Owner>
<ShowHeader>on</ShowHeader>
<SteadyKey>String</SteadyKey>
<StockroomName>String</StockroomName>
</ShowPredictive>