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

<back to all web services

AddHeader

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

        /** @description Area prefix of all areas related to this header */
        // @ApiMember(Description="Area prefix of all areas related to this header", IsRequired=true)
        /** @var string */
        public string $AreaPrefix='',

        /** @description Header group (e.g. same Aisle) */
        // @ApiMember(Description="Header group (e.g. same Aisle)", IsRequired=true)
        /** @var string */
        public string $HeaderGroup='',

        /** @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=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AreaName'])) $this->AreaName = $o['AreaName'];
        if (isset($o['AreaPrefix'])) $this->AreaPrefix = $o['AreaPrefix'];
        if (isset($o['HeaderGroup'])) $this->HeaderGroup = $o['HeaderGroup'];
        if (isset($o['StockroomName'])) $this->StockroomName = $o['StockroomName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AreaName)) $o['AreaName'] = $this->AreaName;
        if (isset($this->AreaPrefix)) $o['AreaPrefix'] = $this->AreaPrefix;
        if (isset($this->HeaderGroup)) $o['HeaderGroup'] = $this->HeaderGroup;
        if (isset($this->StockroomName)) $o['StockroomName'] = $this->StockroomName;
        return empty($o) ? new class(){} : $o;
    }
}

PHP AddHeader DTOs

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

HTTP + JSV

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

POST /AddHeader/{AreaName}/{AreaPrefix}/{HeaderGroup} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AreaName: String,
	AreaPrefix: String,
	HeaderGroup: String,
	StockroomName: String
}