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

<back to all web services

PBL_SetFreePosition

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

        /** @description LCAddress */
        // @ApiMember(Description="LCAddress", IsRequired=true)
        /** @var string */
        public string $LCAddress='',

        /** @description Number of first pixel */
        // @ApiMember(Description="Number of first pixel", IsRequired=true)
        /** @var int */
        public int $PixelBegin=0,

        /** @description Number of last pixel */
        // @ApiMember(Description="Number of last pixel", IsRequired=true)
        /** @var int */
        public int $PixelEnd=0,

        /** @description Output number */
        // @ApiMember(Description="Output number", IsRequired=true)
        /** @var int */
        public int $OutputNumber=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Key'])) $this->Key = $o['Key'];
        if (isset($o['LCAddress'])) $this->LCAddress = $o['LCAddress'];
        if (isset($o['PixelBegin'])) $this->PixelBegin = $o['PixelBegin'];
        if (isset($o['PixelEnd'])) $this->PixelEnd = $o['PixelEnd'];
        if (isset($o['OutputNumber'])) $this->OutputNumber = $o['OutputNumber'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Key)) $o['Key'] = $this->Key;
        if (isset($this->LCAddress)) $o['LCAddress'] = $this->LCAddress;
        if (isset($this->PixelBegin)) $o['PixelBegin'] = $this->PixelBegin;
        if (isset($this->PixelEnd)) $o['PixelEnd'] = $this->PixelEnd;
        if (isset($this->OutputNumber)) $o['OutputNumber'] = $this->OutputNumber;
        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_SetFreePosition DTOs

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

HTTP + XML

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

POST /PBL_SetFreePosition/{Key}/{LCAddress}/{PixelBegin}/{PixelEnd}/{OutputNumber} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PBL_SetFreePosition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Key>String</Key>
  <LCAddress>String</LCAddress>
  <OutputNumber>0</OutputNumber>
  <PixelBegin>0</PixelBegin>
  <PixelEnd>0</PixelEnd>
</PBL_SetFreePosition>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PBL_StandardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Error>String</Error>
  <Result />
  <Success>false</Success>
</PBL_StandardResponse>