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

<back to all web services

MissionCreate

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

        /** @description Mission info */
        // @ApiMember(Description="Mission info")
        /** @var string */
        public string $Info='',

        /** @description Delete automatically when completed */
        // @ApiMember(Description="Delete automatically when completed")
        /** @var bool|null */
        public ?bool $DeleteWhenCompleted=null,

        /** @description Mission owner */
        // @ApiMember(Description="Mission owner")
        /** @var string */
        public string $Owner='',

        /** @description Mission finder key */
        // @ApiMember(Description="Mission finder key")
        /** @var string */
        public string $FinderKey='',

        /** @description Defines the mission type. Value can be: E = Entrée/Réapro/Restock, S = Sortie/Picking/Prépa commande or, I = Inventaire/Inventory */
        // @ApiMember(Description="Defines the mission type. Value can be: E = Entrée/Réapro/Restock, S = Sortie/Picking/Prépa commande or, I = Inventaire/Inventory")
        /** @var string */
        public string $Type='',

        /** @description Mission trolley */
        // @ApiMember(Description="Mission trolley")
        /** @var string */
        public string $Trolley='',

        /** @description Reference of the target printer */
        // @ApiMember(Description="Reference of the target printer")
        /** @var string */
        public string $Printer='',

        /** @description Defines if the mission has been cancelled */
        // @ApiMember(Description="Defines if the mission has been cancelled")
        /** @var bool|null */
        public ?bool $Cancelled=null,

        /** @description Defines if the mission has been blocked */
        // @ApiMember(Description="Defines if the mission has been blocked")
        /** @var bool|null */
        public ?bool $Blocked=null,

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

        /** @description BatchId */
        // @ApiMember(Description="BatchId")
        /** @var string */
        public string $BatchId=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Info'])) $this->Info = $o['Info'];
        if (isset($o['DeleteWhenCompleted'])) $this->DeleteWhenCompleted = $o['DeleteWhenCompleted'];
        if (isset($o['Owner'])) $this->Owner = $o['Owner'];
        if (isset($o['FinderKey'])) $this->FinderKey = $o['FinderKey'];
        if (isset($o['Type'])) $this->Type = $o['Type'];
        if (isset($o['Trolley'])) $this->Trolley = $o['Trolley'];
        if (isset($o['Printer'])) $this->Printer = $o['Printer'];
        if (isset($o['Cancelled'])) $this->Cancelled = $o['Cancelled'];
        if (isset($o['Blocked'])) $this->Blocked = $o['Blocked'];
        if (isset($o['Carrier'])) $this->Carrier = $o['Carrier'];
        if (isset($o['BatchId'])) $this->BatchId = $o['BatchId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Info)) $o['Info'] = $this->Info;
        if (isset($this->DeleteWhenCompleted)) $o['DeleteWhenCompleted'] = $this->DeleteWhenCompleted;
        if (isset($this->Owner)) $o['Owner'] = $this->Owner;
        if (isset($this->FinderKey)) $o['FinderKey'] = $this->FinderKey;
        if (isset($this->Type)) $o['Type'] = $this->Type;
        if (isset($this->Trolley)) $o['Trolley'] = $this->Trolley;
        if (isset($this->Printer)) $o['Printer'] = $this->Printer;
        if (isset($this->Cancelled)) $o['Cancelled'] = $this->Cancelled;
        if (isset($this->Blocked)) $o['Blocked'] = $this->Blocked;
        if (isset($this->Carrier)) $o['Carrier'] = $this->Carrier;
        if (isset($this->BatchId)) $o['BatchId'] = $this->BatchId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP MissionCreate 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 /MissionCreate/{Name} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MissionCreate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <BatchId>String</BatchId>
  <Blocked>false</Blocked>
  <Cancelled>false</Cancelled>
  <Carrier>String</Carrier>
  <DeleteWhenCompleted>false</DeleteWhenCompleted>
  <FinderKey>String</FinderKey>
  <Info>String</Info>
  <Name>String</Name>
  <Owner>String</Owner>
  <Printer>String</Printer>
  <Trolley>String</Trolley>
  <Type>String</Type>
</MissionCreate>