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

<back to all web services

SetPositions

Requires Authentication
The following routes are available for this service:
All Verbs/SetPositions
<?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 Position implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ID=0,
        /** @var string */
        public string $Key='',
        /** @var int */
        public int $Pixel=0,
        /** @var int */
        public int $Width=0,
        /** @var int */
        public int $AreaID=0,
        /** @var string */
        public string $AreaLabel='',
        /** @var string */
        public string $Label='',
        /** @var int|null */
        public ?int $StockroomID=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ID'])) $this->ID = $o['ID'];
        if (isset($o['Key'])) $this->Key = $o['Key'];
        if (isset($o['Pixel'])) $this->Pixel = $o['Pixel'];
        if (isset($o['Width'])) $this->Width = $o['Width'];
        if (isset($o['AreaID'])) $this->AreaID = $o['AreaID'];
        if (isset($o['AreaLabel'])) $this->AreaLabel = $o['AreaLabel'];
        if (isset($o['Label'])) $this->Label = $o['Label'];
        if (isset($o['StockroomID'])) $this->StockroomID = $o['StockroomID'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ID)) $o['ID'] = $this->ID;
        if (isset($this->Key)) $o['Key'] = $this->Key;
        if (isset($this->Pixel)) $o['Pixel'] = $this->Pixel;
        if (isset($this->Width)) $o['Width'] = $this->Width;
        if (isset($this->AreaID)) $o['AreaID'] = $this->AreaID;
        if (isset($this->AreaLabel)) $o['AreaLabel'] = $this->AreaLabel;
        if (isset($this->Label)) $o['Label'] = $this->Label;
        if (isset($this->StockroomID)) $o['StockroomID'] = $this->StockroomID;
        return empty($o) ? new class(){} : $o;
    }
}

class SetPositions implements JsonSerializable
{
    public function __construct(
        /** @description Key identifying a location */
        // @ApiMember(Description="Key identifying a location", IsRequired=true)
        /** @var Position[] */
        public array $Positions=[],

        /** @description Optional: name of the stockroom where the position is located */
        // @ApiMember(Description="Optional: name of the stockroom where the position is located")
        /** @var string */
        public string $StockroomName='',

        /** @description Optional: overwrite existing positions defined with the same key: Yes by default */
        // @ApiMember(Description="Optional: overwrite existing positions defined with the same key: Yes by default")
        /** @var bool|null */
        public ?bool $Overwrite=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Positions'])) $this->Positions = JsonConverters::fromArray('Position', $o['Positions']);
        if (isset($o['StockroomName'])) $this->StockroomName = $o['StockroomName'];
        if (isset($o['Overwrite'])) $this->Overwrite = $o['Overwrite'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Positions)) $o['Positions'] = JsonConverters::toArray('Position', $this->Positions);
        if (isset($this->StockroomName)) $o['StockroomName'] = $this->StockroomName;
        if (isset($this->Overwrite)) $o['Overwrite'] = $this->Overwrite;
        return empty($o) ? new class(){} : $o;
    }
}

PHP SetPositions 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 /SetPositions HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Positions":[{"ID":0,"Key":"String","Pixel":0,"Width":0,"AreaID":0,"AreaLabel":"String","Label":"String","StockroomID":0}],"StockroomName":"String","Overwrite":false}