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

<back to all web services

MissionAddDetail

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

        /** @description Detail reference */
        // @ApiMember(Description="Detail reference", IsRequired=true)
        /** @var string */
        public string $Reference='',

        /** @description Detail label */
        // @ApiMember(Description="Detail label", IsRequired=true)
        /** @var string */
        public string $Label='',

        /** @description Quantity */
        // @ApiMember(Description="Quantity", IsRequired=true)
        /** @var float */
        public float $Quantity=0.0,

        /** @description QuantityPrepared */
        // @ApiMember(Description="QuantityPrepared")
        /** @var float */
        public float $QuantityPrepared=0.0,

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

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

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

        /** @description To be used to identify with certitude a specific line in the mission result repport. */
        // @ApiMember(Description="To be used to identify with certitude a specific line in the mission result repport.")
        /** @var int */
        public int $LineNumber=0,

        /** @description Info about article (Max 100 chars) */
        // @ApiMember(Description="Info about article (Max 100 chars)")
        /** @var string */
        public string $Info='',

        /** @description Position of article (Max 50 chars) */
        // @ApiMember(Description="Position of article (Max 50 chars)")
        /** @var string */
        public string $GTIN='',

        /** @description Product reference used by supplier */
        // @ApiMember(Description="Product reference used by supplier")
        /** @var string */
        public string $SupplierReference='',

        /** @description Can be used to optimize picking. The mission will be sorted using this value */
        // @ApiMember(Description="Can be used to optimize picking. The mission will be sorted using this value")
        /** @var int */
        public int $PickingIndex=0,

        /** @description Defines if an article is substitutable */
        // @ApiMember(Description="Defines if an article is substitutable")
        /** @var bool|null */
        public ?bool $Substitutable=null,

        /** @description Defines the new Reference of substituted article */
        // @ApiMember(Description="Defines the new Reference of substituted article")
        /** @var string */
        public string $SubstitutionRef='',

        /** @description Unique reference of a containing package */
        // @ApiMember(Description="Unique reference of a containing package")
        /** @var string */
        public string $PackageReference='',

        /** @description Number of articles contained in the package */
        // @ApiMember(Description="Number of articles contained in the package")
        /** @var int|null */
        public ?int $NbSKUInPackage=null,

        /** @description Unique reference of a containing package (additional) */
        // @ApiMember(Description="Unique reference of a containing package (additional)")
        /** @var string */
        public string $PackageReference2='',

        /** @description Number of articles contained in the package (additional) */
        // @ApiMember(Description="Number of articles contained in the package (additional)")
        /** @var int|null */
        public ?int $NbSKUInPackage2=null,

        /** @description Uses GTIN to resovle StockLocation from Stock DB Table. Takes only the first stock location found in Stock DB. */
        // @ApiMember(Description="Uses GTIN to resovle StockLocation from Stock DB Table. Takes only the first stock location found in Stock DB.")
        /** @var bool|null */
        public ?bool $ResolveStockLocation=null,

        /** @description Weight per Item in Kg */
        // @ApiMember(Description="Weight per Item in Kg")
        /** @var float|null */
        public ?float $WeightPerItemInKg=null,

        /** @description Volume per Item in m3 */
        // @ApiMember(Description="Volume per Item in m3")
        /** @var float|null */
        public ?float $VolumePerItemInM3=null,

        /** @description URL of picture */
        // @ApiMember(Description="URL of picture")
        /** @var string */
        public string $PictureURL='',

        /** @description Mesure of the item if it is by weight or by piece */
        // @ApiMember(Description="Mesure of the item if it is by weight or by piece")
        /** @var string */
        public string $QuantityUnit='',

        /** @description Product versions */
        // @ApiMember(Description="Product versions")
        /** @var array<string>|null */
        public ?array $Versions=null,

        /** @description Use to know if product need force scan EAN or not */
        // @ApiMember(Description="Use to know if product need force scan EAN or not")
        /** @var bool|null */
        public ?bool $IsProductCritical=null,

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['MissionName'])) $this->MissionName = $o['MissionName'];
        if (isset($o['Reference'])) $this->Reference = $o['Reference'];
        if (isset($o['Label'])) $this->Label = $o['Label'];
        if (isset($o['Quantity'])) $this->Quantity = $o['Quantity'];
        if (isset($o['QuantityPrepared'])) $this->QuantityPrepared = $o['QuantityPrepared'];
        if (isset($o['MissionInfo'])) $this->MissionInfo = $o['MissionInfo'];
        if (isset($o['Tray'])) $this->Tray = $o['Tray'];
        if (isset($o['StockLocation'])) $this->StockLocation = $o['StockLocation'];
        if (isset($o['LineNumber'])) $this->LineNumber = $o['LineNumber'];
        if (isset($o['Info'])) $this->Info = $o['Info'];
        if (isset($o['GTIN'])) $this->GTIN = $o['GTIN'];
        if (isset($o['SupplierReference'])) $this->SupplierReference = $o['SupplierReference'];
        if (isset($o['PickingIndex'])) $this->PickingIndex = $o['PickingIndex'];
        if (isset($o['Substitutable'])) $this->Substitutable = $o['Substitutable'];
        if (isset($o['SubstitutionRef'])) $this->SubstitutionRef = $o['SubstitutionRef'];
        if (isset($o['PackageReference'])) $this->PackageReference = $o['PackageReference'];
        if (isset($o['NbSKUInPackage'])) $this->NbSKUInPackage = $o['NbSKUInPackage'];
        if (isset($o['PackageReference2'])) $this->PackageReference2 = $o['PackageReference2'];
        if (isset($o['NbSKUInPackage2'])) $this->NbSKUInPackage2 = $o['NbSKUInPackage2'];
        if (isset($o['ResolveStockLocation'])) $this->ResolveStockLocation = $o['ResolveStockLocation'];
        if (isset($o['WeightPerItemInKg'])) $this->WeightPerItemInKg = $o['WeightPerItemInKg'];
        if (isset($o['VolumePerItemInM3'])) $this->VolumePerItemInM3 = $o['VolumePerItemInM3'];
        if (isset($o['PictureURL'])) $this->PictureURL = $o['PictureURL'];
        if (isset($o['QuantityUnit'])) $this->QuantityUnit = $o['QuantityUnit'];
        if (isset($o['Versions'])) $this->Versions = JsonConverters::fromArray('string', $o['Versions']);
        if (isset($o['IsProductCritical'])) $this->IsProductCritical = $o['IsProductCritical'];
        if (isset($o['MissionType'])) $this->MissionType = $o['MissionType'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->MissionName)) $o['MissionName'] = $this->MissionName;
        if (isset($this->Reference)) $o['Reference'] = $this->Reference;
        if (isset($this->Label)) $o['Label'] = $this->Label;
        if (isset($this->Quantity)) $o['Quantity'] = $this->Quantity;
        if (isset($this->QuantityPrepared)) $o['QuantityPrepared'] = $this->QuantityPrepared;
        if (isset($this->MissionInfo)) $o['MissionInfo'] = $this->MissionInfo;
        if (isset($this->Tray)) $o['Tray'] = $this->Tray;
        if (isset($this->StockLocation)) $o['StockLocation'] = $this->StockLocation;
        if (isset($this->LineNumber)) $o['LineNumber'] = $this->LineNumber;
        if (isset($this->Info)) $o['Info'] = $this->Info;
        if (isset($this->GTIN)) $o['GTIN'] = $this->GTIN;
        if (isset($this->SupplierReference)) $o['SupplierReference'] = $this->SupplierReference;
        if (isset($this->PickingIndex)) $o['PickingIndex'] = $this->PickingIndex;
        if (isset($this->Substitutable)) $o['Substitutable'] = $this->Substitutable;
        if (isset($this->SubstitutionRef)) $o['SubstitutionRef'] = $this->SubstitutionRef;
        if (isset($this->PackageReference)) $o['PackageReference'] = $this->PackageReference;
        if (isset($this->NbSKUInPackage)) $o['NbSKUInPackage'] = $this->NbSKUInPackage;
        if (isset($this->PackageReference2)) $o['PackageReference2'] = $this->PackageReference2;
        if (isset($this->NbSKUInPackage2)) $o['NbSKUInPackage2'] = $this->NbSKUInPackage2;
        if (isset($this->ResolveStockLocation)) $o['ResolveStockLocation'] = $this->ResolveStockLocation;
        if (isset($this->WeightPerItemInKg)) $o['WeightPerItemInKg'] = $this->WeightPerItemInKg;
        if (isset($this->VolumePerItemInM3)) $o['VolumePerItemInM3'] = $this->VolumePerItemInM3;
        if (isset($this->PictureURL)) $o['PictureURL'] = $this->PictureURL;
        if (isset($this->QuantityUnit)) $o['QuantityUnit'] = $this->QuantityUnit;
        if (isset($this->Versions)) $o['Versions'] = JsonConverters::toArray('string', $this->Versions);
        if (isset($this->IsProductCritical)) $o['IsProductCritical'] = $this->IsProductCritical;
        if (isset($this->MissionType)) $o['MissionType'] = $this->MissionType;
        return empty($o) ? new class(){} : $o;
    }
}

PHP MissionAddDetail 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 /MissionAddDetail/{MissionName}/{Reference}/{Label}/{Quantity} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MissionAddDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <GTIN>String</GTIN>
  <Info>String</Info>
  <IsProductCritical>false</IsProductCritical>
  <Label>String</Label>
  <LineNumber>0</LineNumber>
  <MissionInfo>String</MissionInfo>
  <MissionName>String</MissionName>
  <MissionType>String</MissionType>
  <NbSKUInPackage>0</NbSKUInPackage>
  <NbSKUInPackage2>0</NbSKUInPackage2>
  <PackageReference>String</PackageReference>
  <PackageReference2>String</PackageReference2>
  <PickingIndex>0</PickingIndex>
  <PictureURL>String</PictureURL>
  <Quantity>0</Quantity>
  <QuantityPrepared>0</QuantityPrepared>
  <QuantityUnit>String</QuantityUnit>
  <Reference>String</Reference>
  <ResolveStockLocation>false</ResolveStockLocation>
  <StockLocation>String</StockLocation>
  <Substitutable>false</Substitutable>
  <SubstitutionRef>String</SubstitutionRef>
  <SupplierReference>String</SupplierReference>
  <Tray>String</Tray>
  <Versions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Versions>
  <VolumePerItemInM3>0</VolumePerItemInM3>
  <WeightPerItemInKg>0</WeightPerItemInKg>
</MissionAddDetail>