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

<back to all web services

PBL_SwitchOffPosition

Requires Authentication
The following routes are available for this service:
All Verbs/PBL_SwitchOffPosition
<?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_SwitchOffPosition implements JsonSerializable
{
    public function __construct(
        /** @description Position identifying a LED location */
        // @ApiMember(Description="Position identifying a LED location", IsRequired=true)
        /** @var string */
        public string $Position='',

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

        /** @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: set paramter to TRUE if you need to turn off any color previously turned ON at specified position */
        // @ApiMember(Description="Optional: set paramter to TRUE if you need to turn off any color previously turned ON at specified position")
        /** @var bool|null */
        public ?bool $SwitchOffAnyColor=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Position'])) $this->Position = $o['Position'];
        if (isset($o['Color'])) $this->Color = $o['Color'];
        if (isset($o['Owner'])) $this->Owner = $o['Owner'];
        if (isset($o['SwitchOffAnyColor'])) $this->SwitchOffAnyColor = $o['SwitchOffAnyColor'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Position)) $o['Position'] = $this->Position;
        if (isset($this->Color)) $o['Color'] = $this->Color;
        if (isset($this->Owner)) $o['Owner'] = $this->Owner;
        if (isset($this->SwitchOffAnyColor)) $o['SwitchOffAnyColor'] = $this->SwitchOffAnyColor;
        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_SwitchOffPosition DTOs

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

HTTP + CSV

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

POST /PBL_SwitchOffPosition HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Position":"String","Color":"String","Owner":"String","SwitchOffAnyColor":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Success":false,"Error":"String","Result":{},"Color":"String"}