Go-to-Light Service 4.0.0.2397 - 121 - API License to Cloud Demo

<back to all web services

ShowOnArea

Requires Authentication
The following routes are available for this service:
All Verbs/ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{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 ShowOnArea implements JsonSerializable
{
    public function __construct(
        /** @description Area ID */
        // @ApiMember(Description="Area ID", IsRequired=true)
        /** @var int */
        public int $AreaID=0,

        /** @description HTML Color code (e.g. FF00FF) */
        // @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
        /** @var string */
        public string $Color='',

        /** @description Pixel number on the area */
        // @ApiMember(Description="Pixel number on the area", IsRequired=true)
        /** @var int */
        public int $Pixel=0,

        /** @description Pixel width */
        // @ApiMember(Description="Pixel width", IsRequired=true)
        /** @var int */
        public int $Width=0,

        /** @description Blinking or not */
        // @ApiMember(Description="Blinking or not", IsRequired=true)
        /** @var bool|null */
        public ?bool $Blink=null,

        /** @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 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
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AreaID'])) $this->AreaID = $o['AreaID'];
        if (isset($o['Color'])) $this->Color = $o['Color'];
        if (isset($o['Pixel'])) $this->Pixel = $o['Pixel'];
        if (isset($o['Width'])) $this->Width = $o['Width'];
        if (isset($o['Blink'])) $this->Blink = $o['Blink'];
        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['Owner'])) $this->Owner = $o['Owner'];
        if (isset($o['Unreliable'])) $this->Unreliable = $o['Unreliable'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AreaID)) $o['AreaID'] = $this->AreaID;
        if (isset($this->Color)) $o['Color'] = $this->Color;
        if (isset($this->Pixel)) $o['Pixel'] = $this->Pixel;
        if (isset($this->Width)) $o['Width'] = $this->Width;
        if (isset($this->Blink)) $o['Blink'] = $this->Blink;
        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->Owner)) $o['Owner'] = $this->Owner;
        if (isset($this->Unreliable)) $o['Unreliable'] = $this->Unreliable;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ShowOnArea DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"AreaID":0,"Color":"String","Pixel":0,"Width":0,"Blink":false,"Persistant":false,"Delay":0,"Duration":0,"Owner":"String","Unreliable":false}