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

<back to all web services

ShowAllPositionsOfArea

Requires Authentication
The following routes are available for this service:
All Verbs/ShowAllPositionsOfArea/{AreaID}/{Color}
<?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 ShowAllPositionsOfArea 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 Name of the owner of the color/command to allow color sharing */
        // @ApiMember(Description="Name of the owner of the color/command to allow color sharing")
        /** @var string */
        public string $Owner=''
    ) {
    }

    /** @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['Owner'])) $this->Owner = $o['Owner'];
    }
    
    /** @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->Owner)) $o['Owner'] = $this->Owner;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ShowAllPositionsOfArea 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 /ShowAllPositionsOfArea/{AreaID}/{Color} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"AreaID":0,"Color":"String","Owner":"String"}