Mercedes.Agency.Orchestration.API

ValidateBackOrderBulkAllocationsRequest

The following routes are available for this service:
POST	/v1/BackOrder/ValidateBulkAllocations

<?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 ValidateBackOrderBulkAllocationsRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

class BackOrderAllocation implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Row=0,
        /** @var string */
        public string $Comm='',
        /** @var string */
        public string $BackOrder=''
    ) {
    }

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

class InvalidBackOrderAllocation extends BackOrderAllocation implements JsonSerializable
{
    /**
     * @param int $Row
     * @param string $Comm
     * @param string $BackOrder
     */
    public function __construct(
        int $Row=0,
        string $Comm='',
        string $BackOrder='',
        /** @var string */
        public string $ValidationMessage=''
    ) {
        parent::__construct($Row,$Comm,$BackOrder);
    }

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

class BackOrderBulkAllocationVehicles implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $TotalVehicles=0,
        /** @var int */
        public int $ValidVehicles=0,
        /** @var int */
        public int $WarningVehicles=0,
        /** @var int */
        public int $InvalidVehicles=0,
        /** @var array<BackOrderAllocation>|null */
        public ?array $Valid=null,
        /** @var array<InvalidBackOrderAllocation>|null */
        public ?array $Warning=null,
        /** @var array<InvalidBackOrderAllocation>|null */
        public ?array $Invalid=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TotalVehicles'])) $this->TotalVehicles = $o['TotalVehicles'];
        if (isset($o['ValidVehicles'])) $this->ValidVehicles = $o['ValidVehicles'];
        if (isset($o['WarningVehicles'])) $this->WarningVehicles = $o['WarningVehicles'];
        if (isset($o['InvalidVehicles'])) $this->InvalidVehicles = $o['InvalidVehicles'];
        if (isset($o['Valid'])) $this->Valid = JsonConverters::fromArray('BackOrderAllocation', $o['Valid']);
        if (isset($o['Warning'])) $this->Warning = JsonConverters::fromArray('InvalidBackOrderAllocation', $o['Warning']);
        if (isset($o['Invalid'])) $this->Invalid = JsonConverters::fromArray('InvalidBackOrderAllocation', $o['Invalid']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TotalVehicles)) $o['TotalVehicles'] = $this->TotalVehicles;
        if (isset($this->ValidVehicles)) $o['ValidVehicles'] = $this->ValidVehicles;
        if (isset($this->WarningVehicles)) $o['WarningVehicles'] = $this->WarningVehicles;
        if (isset($this->InvalidVehicles)) $o['InvalidVehicles'] = $this->InvalidVehicles;
        if (isset($this->Valid)) $o['Valid'] = JsonConverters::toArray('BackOrderAllocation', $this->Valid);
        if (isset($this->Warning)) $o['Warning'] = JsonConverters::toArray('InvalidBackOrderAllocation', $this->Warning);
        if (isset($this->Invalid)) $o['Invalid'] = JsonConverters::toArray('InvalidBackOrderAllocation', $this->Invalid);
        return empty($o) ? new class(){} : $o;
    }
}

class BackOrderBulkAllocationResponse implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $Message='',
        /** @var BackOrderBulkAllocationVehicles|null */
        public ?BackOrderBulkAllocationVehicles $Vehicles=null,
        /** @var bool|null */
        public ?bool $Successful=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Message'])) $this->Message = $o['Message'];
        if (isset($o['Vehicles'])) $this->Vehicles = JsonConverters::from('BackOrderBulkAllocationVehicles', $o['Vehicles']);
        if (isset($o['Successful'])) $this->Successful = $o['Successful'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Message)) $o['Message'] = $this->Message;
        if (isset($this->Vehicles)) $o['Vehicles'] = JsonConverters::to('BackOrderBulkAllocationVehicles', $this->Vehicles);
        if (isset($this->Successful)) $o['Successful'] = $this->Successful;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ValidateBackOrderBulkAllocationsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v1/BackOrder/ValidateBulkAllocations HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/json
Content-Type: application/json
Content-Length: length

{}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Message":"One or more errors in file","Vehicles":{"TotalVehicles":3,"ValidVehicles":1,"WarningVehicles":1,"InvalidVehicles":1,"Valid":[{"Row":0,"Comm":"String","BackOrder":"String"}],"Warning":[{"ValidationMessage":"String","Row":0,"Comm":"String","BackOrder":"String"}],"Invalid":[{"ValidationMessage":"String","Row":0,"Comm":"String","BackOrder":"String"}]},"Successful":false}