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

<back to all web services

AddNodeToArea

Requires Authentication
The following routes are available for this service:
All Verbs/AddNodeToArea/{Area}/{LCAddress}/{PixelStart}/{PixelStop}/{Index}
<?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 AddNodeToArea implements JsonSerializable
{
    public function __construct(
        /** @description Area name */
        // @ApiMember(Description="Area name", IsRequired=true)
        /** @var string */
        public string $Area='',

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

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

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

        /** @description Index of node in the group */
        // @ApiMember(Description="Index of node in the group", IsRequired=true)
        /** @var int */
        public int $Index=0,

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

        /** @description Optional: reverse direction */
        // @ApiMember(Description="Optional: reverse direction")
        /** @var bool|null */
        public ?bool $Reverse=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Area'])) $this->Area = $o['Area'];
        if (isset($o['LCAddress'])) $this->LCAddress = $o['LCAddress'];
        if (isset($o['PixelStart'])) $this->PixelStart = $o['PixelStart'];
        if (isset($o['PixelStop'])) $this->PixelStop = $o['PixelStop'];
        if (isset($o['Index'])) $this->Index = $o['Index'];
        if (isset($o['StockroomName'])) $this->StockroomName = $o['StockroomName'];
        if (isset($o['Reverse'])) $this->Reverse = $o['Reverse'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Area)) $o['Area'] = $this->Area;
        if (isset($this->LCAddress)) $o['LCAddress'] = $this->LCAddress;
        if (isset($this->PixelStart)) $o['PixelStart'] = $this->PixelStart;
        if (isset($this->PixelStop)) $o['PixelStop'] = $this->PixelStop;
        if (isset($this->Index)) $o['Index'] = $this->Index;
        if (isset($this->StockroomName)) $o['StockroomName'] = $this->StockroomName;
        if (isset($this->Reverse)) $o['Reverse'] = $this->Reverse;
        return empty($o) ? new class(){} : $o;
    }
}

PHP AddNodeToArea 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 /AddNodeToArea/{Area}/{LCAddress}/{PixelStart}/{PixelStop}/{Index} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddNodeToArea xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Area>String</Area>
  <Index>0</Index>
  <LCAddress>String</LCAddress>
  <PixelStart>0</PixelStart>
  <PixelStop>0</PixelStop>
  <Reverse>false</Reverse>
  <StockroomName>String</StockroomName>
</AddNodeToArea>