Mercedes.Agency.Orchestration.API

<back to all web services

GetBackOrderCsvMatchAllRequest

BackOrder
Requires Authentication
The following routes are available for this service:
GET/v1/backordercsv/match/allGet Back Order Match All
GET/v1/backordercsv/match/all/{Guid}Get Back Order Match All by Guid
<?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 GetBackOrderMatchRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $Guid=''
    ) {
    }

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

class BackOrderVehicleCsv implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $VehicleType='',
        /** @var string */
        public string $Vid='',
        /** @var string */
        public string $Vin='',
        /** @var string */
        public string $Fin='',
        /** @var string */
        public string $CommissionNumber='',
        /** @var string */
        public string $ChassisNumber='',
        /** @var string */
        public string $Line='',
        /** @var array<string>|null */
        public ?array $Packages=null,
        /** @var string */
        public string $ModelYear='',
        /** @var string */
        public string $ModelYearCode='',
        /** @var string */
        public string $Description='',
        /** @var string */
        public string $VehicleClass='',
        /** @var string */
        public string $RetailPrice_ExVAT='',
        /** @var float|null */
        public ?float $RetailPrice_IncVAT=null,
        /** @var string */
        public string $OTR='',
        /** @var string */
        public string $ActualPrice='',
        /** @var string */
        public string $BodyStyle='',
        /** @var string */
        public string $Model='',
        /** @var string */
        public string $Colour='',
        /** @var string */
        public string $ColourGroup='',
        /** @var string */
        public string $Fuel='',
        /** @var string */
        public string $ProductRange='',
        /** @var string */
        public string $Engine='',
        /** @var bool|null */
        public ?bool $IsAMG=null,
        /** @var string */
        public string $Transmission='',
        /** @var string */
        public string $Upholstery='',
        /** @var string */
        public string $Nst='',
        /** @var string */
        public string $BM7NST='',
        /** @var float|null */
        public ?float $Acceleration=null,
        /** @var float|null */
        public ?float $BootCapacity=null,
        /** @var float|null */
        public ?float $TopSpeed=null,
        /** @var string */
        public string $DriveConcept='',
        /** @var float|null */
        public ?float $CombustionPowerHp=null,
        /** @var float|null */
        public ?float $ElectricPowerKw=null,
        /** @var float|null */
        public ?float $ElectricPowerHp=null,
        /** @var float|null */
        public ?float $CombinedPowerKw=null,
        /** @var float|null */
        public ?float $CombinedPowerHP=null,
        /** @var float|null */
        public ?float $ElectricRange=null,
        /** @var float|null */
        public ?float $ElectricConsumption=null,
        /** @var string */
        public string $EmissionCombined='',
        /** @var string */
        public string $EmissionExtraUrban='',
        /** @var string */
        public string $EmissionUrban='',
        /** @var float|null */
        public ?float $Emission=null,
        /** @var string */
        public string $EmissionDirective='',
        /** @var string */
        public string $EnergyEfficiencyClass='',
        /** @var float|null */
        public ?float $WltpCombined=null,
        /** @var float|null */
        public ?float $WltpLow=null,
        /** @var float|null */
        public ?float $WltpMedium=null,
        /** @var float|null */
        public ?float $WltpHigh=null,
        /** @var float|null */
        public ?float $WltpExtraHigh=null,
        /** @var float|null */
        public ?float $WltpEmissionCombined=null,
        /** @var string */
        public string $PortArrivalDate='',
        /** @var DateTime|null */
        public ?DateTime $CreationDate=null,
        /** @var DateTime|null */
        public ?DateTime $LastUpdated=null,
        /** @var bool|null */
        public ?bool $IsDisplayStock=null,
        /** @var string */
        public string $DisplayStockAgent='',
        /** @var bool|null */
        public ?bool $IsSpecialistCar=null,
        /** @var string */
        public string $Account='',
        /** @var string */
        public string $Location='',
        /** @var string */
        public string $CesarIdShipToParty='',
        /** @var string */
        public string $VehicleUsageCode='',
        /** @var bool|null */
        public ?bool $IsSellable=null,
        /** @var bool|null */
        public ?bool $UnderOffer=null,
        /** @var bool|null */
        public ?bool $MbukSecured=null,
        /** @var string */
        public string $HalfModelYearCode='',
        /** @var string */
        public string $FullModelYearCode='',
        /** @var string */
        public string $ProductionDate='',
        /** @var bool|null */
        public ?bool $IsMotability=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['VehicleType'])) $this->VehicleType = $o['VehicleType'];
        if (isset($o['Vid'])) $this->Vid = $o['Vid'];
        if (isset($o['Vin'])) $this->Vin = $o['Vin'];
        if (isset($o['Fin'])) $this->Fin = $o['Fin'];
        if (isset($o['CommissionNumber'])) $this->CommissionNumber = $o['CommissionNumber'];
        if (isset($o['ChassisNumber'])) $this->ChassisNumber = $o['ChassisNumber'];
        if (isset($o['Line'])) $this->Line = $o['Line'];
        if (isset($o['Packages'])) $this->Packages = JsonConverters::fromArray('string', $o['Packages']);
        if (isset($o['ModelYear'])) $this->ModelYear = $o['ModelYear'];
        if (isset($o['ModelYearCode'])) $this->ModelYearCode = $o['ModelYearCode'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['VehicleClass'])) $this->VehicleClass = $o['VehicleClass'];
        if (isset($o['RetailPrice_ExVAT'])) $this->RetailPrice_ExVAT = $o['RetailPrice_ExVAT'];
        if (isset($o['RetailPrice_IncVAT'])) $this->RetailPrice_IncVAT = $o['RetailPrice_IncVAT'];
        if (isset($o['OTR'])) $this->OTR = $o['OTR'];
        if (isset($o['ActualPrice'])) $this->ActualPrice = $o['ActualPrice'];
        if (isset($o['BodyStyle'])) $this->BodyStyle = $o['BodyStyle'];
        if (isset($o['Model'])) $this->Model = $o['Model'];
        if (isset($o['Colour'])) $this->Colour = $o['Colour'];
        if (isset($o['ColourGroup'])) $this->ColourGroup = $o['ColourGroup'];
        if (isset($o['Fuel'])) $this->Fuel = $o['Fuel'];
        if (isset($o['ProductRange'])) $this->ProductRange = $o['ProductRange'];
        if (isset($o['Engine'])) $this->Engine = $o['Engine'];
        if (isset($o['IsAMG'])) $this->IsAMG = $o['IsAMG'];
        if (isset($o['Transmission'])) $this->Transmission = $o['Transmission'];
        if (isset($o['Upholstery'])) $this->Upholstery = $o['Upholstery'];
        if (isset($o['Nst'])) $this->Nst = $o['Nst'];
        if (isset($o['BM7NST'])) $this->BM7NST = $o['BM7NST'];
        if (isset($o['Acceleration'])) $this->Acceleration = $o['Acceleration'];
        if (isset($o['BootCapacity'])) $this->BootCapacity = $o['BootCapacity'];
        if (isset($o['TopSpeed'])) $this->TopSpeed = $o['TopSpeed'];
        if (isset($o['DriveConcept'])) $this->DriveConcept = $o['DriveConcept'];
        if (isset($o['CombustionPowerHp'])) $this->CombustionPowerHp = $o['CombustionPowerHp'];
        if (isset($o['ElectricPowerKw'])) $this->ElectricPowerKw = $o['ElectricPowerKw'];
        if (isset($o['ElectricPowerHp'])) $this->ElectricPowerHp = $o['ElectricPowerHp'];
        if (isset($o['CombinedPowerKw'])) $this->CombinedPowerKw = $o['CombinedPowerKw'];
        if (isset($o['CombinedPowerHP'])) $this->CombinedPowerHP = $o['CombinedPowerHP'];
        if (isset($o['ElectricRange'])) $this->ElectricRange = $o['ElectricRange'];
        if (isset($o['ElectricConsumption'])) $this->ElectricConsumption = $o['ElectricConsumption'];
        if (isset($o['EmissionCombined'])) $this->EmissionCombined = $o['EmissionCombined'];
        if (isset($o['EmissionExtraUrban'])) $this->EmissionExtraUrban = $o['EmissionExtraUrban'];
        if (isset($o['EmissionUrban'])) $this->EmissionUrban = $o['EmissionUrban'];
        if (isset($o['Emission'])) $this->Emission = $o['Emission'];
        if (isset($o['EmissionDirective'])) $this->EmissionDirective = $o['EmissionDirective'];
        if (isset($o['EnergyEfficiencyClass'])) $this->EnergyEfficiencyClass = $o['EnergyEfficiencyClass'];
        if (isset($o['WltpCombined'])) $this->WltpCombined = $o['WltpCombined'];
        if (isset($o['WltpLow'])) $this->WltpLow = $o['WltpLow'];
        if (isset($o['WltpMedium'])) $this->WltpMedium = $o['WltpMedium'];
        if (isset($o['WltpHigh'])) $this->WltpHigh = $o['WltpHigh'];
        if (isset($o['WltpExtraHigh'])) $this->WltpExtraHigh = $o['WltpExtraHigh'];
        if (isset($o['WltpEmissionCombined'])) $this->WltpEmissionCombined = $o['WltpEmissionCombined'];
        if (isset($o['PortArrivalDate'])) $this->PortArrivalDate = $o['PortArrivalDate'];
        if (isset($o['CreationDate'])) $this->CreationDate = JsonConverters::from('DateTime', $o['CreationDate']);
        if (isset($o['LastUpdated'])) $this->LastUpdated = JsonConverters::from('DateTime', $o['LastUpdated']);
        if (isset($o['IsDisplayStock'])) $this->IsDisplayStock = $o['IsDisplayStock'];
        if (isset($o['DisplayStockAgent'])) $this->DisplayStockAgent = $o['DisplayStockAgent'];
        if (isset($o['IsSpecialistCar'])) $this->IsSpecialistCar = $o['IsSpecialistCar'];
        if (isset($o['Account'])) $this->Account = $o['Account'];
        if (isset($o['Location'])) $this->Location = $o['Location'];
        if (isset($o['CesarIdShipToParty'])) $this->CesarIdShipToParty = $o['CesarIdShipToParty'];
        if (isset($o['VehicleUsageCode'])) $this->VehicleUsageCode = $o['VehicleUsageCode'];
        if (isset($o['IsSellable'])) $this->IsSellable = $o['IsSellable'];
        if (isset($o['UnderOffer'])) $this->UnderOffer = $o['UnderOffer'];
        if (isset($o['MbukSecured'])) $this->MbukSecured = $o['MbukSecured'];
        if (isset($o['HalfModelYearCode'])) $this->HalfModelYearCode = $o['HalfModelYearCode'];
        if (isset($o['FullModelYearCode'])) $this->FullModelYearCode = $o['FullModelYearCode'];
        if (isset($o['ProductionDate'])) $this->ProductionDate = $o['ProductionDate'];
        if (isset($o['IsMotability'])) $this->IsMotability = $o['IsMotability'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->VehicleType)) $o['VehicleType'] = $this->VehicleType;
        if (isset($this->Vid)) $o['Vid'] = $this->Vid;
        if (isset($this->Vin)) $o['Vin'] = $this->Vin;
        if (isset($this->Fin)) $o['Fin'] = $this->Fin;
        if (isset($this->CommissionNumber)) $o['CommissionNumber'] = $this->CommissionNumber;
        if (isset($this->ChassisNumber)) $o['ChassisNumber'] = $this->ChassisNumber;
        if (isset($this->Line)) $o['Line'] = $this->Line;
        if (isset($this->Packages)) $o['Packages'] = JsonConverters::toArray('string', $this->Packages);
        if (isset($this->ModelYear)) $o['ModelYear'] = $this->ModelYear;
        if (isset($this->ModelYearCode)) $o['ModelYearCode'] = $this->ModelYearCode;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->VehicleClass)) $o['VehicleClass'] = $this->VehicleClass;
        if (isset($this->RetailPrice_ExVAT)) $o['RetailPrice_ExVAT'] = $this->RetailPrice_ExVAT;
        if (isset($this->RetailPrice_IncVAT)) $o['RetailPrice_IncVAT'] = $this->RetailPrice_IncVAT;
        if (isset($this->OTR)) $o['OTR'] = $this->OTR;
        if (isset($this->ActualPrice)) $o['ActualPrice'] = $this->ActualPrice;
        if (isset($this->BodyStyle)) $o['BodyStyle'] = $this->BodyStyle;
        if (isset($this->Model)) $o['Model'] = $this->Model;
        if (isset($this->Colour)) $o['Colour'] = $this->Colour;
        if (isset($this->ColourGroup)) $o['ColourGroup'] = $this->ColourGroup;
        if (isset($this->Fuel)) $o['Fuel'] = $this->Fuel;
        if (isset($this->ProductRange)) $o['ProductRange'] = $this->ProductRange;
        if (isset($this->Engine)) $o['Engine'] = $this->Engine;
        if (isset($this->IsAMG)) $o['IsAMG'] = $this->IsAMG;
        if (isset($this->Transmission)) $o['Transmission'] = $this->Transmission;
        if (isset($this->Upholstery)) $o['Upholstery'] = $this->Upholstery;
        if (isset($this->Nst)) $o['Nst'] = $this->Nst;
        if (isset($this->BM7NST)) $o['BM7NST'] = $this->BM7NST;
        if (isset($this->Acceleration)) $o['Acceleration'] = $this->Acceleration;
        if (isset($this->BootCapacity)) $o['BootCapacity'] = $this->BootCapacity;
        if (isset($this->TopSpeed)) $o['TopSpeed'] = $this->TopSpeed;
        if (isset($this->DriveConcept)) $o['DriveConcept'] = $this->DriveConcept;
        if (isset($this->CombustionPowerHp)) $o['CombustionPowerHp'] = $this->CombustionPowerHp;
        if (isset($this->ElectricPowerKw)) $o['ElectricPowerKw'] = $this->ElectricPowerKw;
        if (isset($this->ElectricPowerHp)) $o['ElectricPowerHp'] = $this->ElectricPowerHp;
        if (isset($this->CombinedPowerKw)) $o['CombinedPowerKw'] = $this->CombinedPowerKw;
        if (isset($this->CombinedPowerHP)) $o['CombinedPowerHP'] = $this->CombinedPowerHP;
        if (isset($this->ElectricRange)) $o['ElectricRange'] = $this->ElectricRange;
        if (isset($this->ElectricConsumption)) $o['ElectricConsumption'] = $this->ElectricConsumption;
        if (isset($this->EmissionCombined)) $o['EmissionCombined'] = $this->EmissionCombined;
        if (isset($this->EmissionExtraUrban)) $o['EmissionExtraUrban'] = $this->EmissionExtraUrban;
        if (isset($this->EmissionUrban)) $o['EmissionUrban'] = $this->EmissionUrban;
        if (isset($this->Emission)) $o['Emission'] = $this->Emission;
        if (isset($this->EmissionDirective)) $o['EmissionDirective'] = $this->EmissionDirective;
        if (isset($this->EnergyEfficiencyClass)) $o['EnergyEfficiencyClass'] = $this->EnergyEfficiencyClass;
        if (isset($this->WltpCombined)) $o['WltpCombined'] = $this->WltpCombined;
        if (isset($this->WltpLow)) $o['WltpLow'] = $this->WltpLow;
        if (isset($this->WltpMedium)) $o['WltpMedium'] = $this->WltpMedium;
        if (isset($this->WltpHigh)) $o['WltpHigh'] = $this->WltpHigh;
        if (isset($this->WltpExtraHigh)) $o['WltpExtraHigh'] = $this->WltpExtraHigh;
        if (isset($this->WltpEmissionCombined)) $o['WltpEmissionCombined'] = $this->WltpEmissionCombined;
        if (isset($this->PortArrivalDate)) $o['PortArrivalDate'] = $this->PortArrivalDate;
        if (isset($this->CreationDate)) $o['CreationDate'] = JsonConverters::to('DateTime', $this->CreationDate);
        if (isset($this->LastUpdated)) $o['LastUpdated'] = JsonConverters::to('DateTime', $this->LastUpdated);
        if (isset($this->IsDisplayStock)) $o['IsDisplayStock'] = $this->IsDisplayStock;
        if (isset($this->DisplayStockAgent)) $o['DisplayStockAgent'] = $this->DisplayStockAgent;
        if (isset($this->IsSpecialistCar)) $o['IsSpecialistCar'] = $this->IsSpecialistCar;
        if (isset($this->Account)) $o['Account'] = $this->Account;
        if (isset($this->Location)) $o['Location'] = $this->Location;
        if (isset($this->CesarIdShipToParty)) $o['CesarIdShipToParty'] = $this->CesarIdShipToParty;
        if (isset($this->VehicleUsageCode)) $o['VehicleUsageCode'] = $this->VehicleUsageCode;
        if (isset($this->IsSellable)) $o['IsSellable'] = $this->IsSellable;
        if (isset($this->UnderOffer)) $o['UnderOffer'] = $this->UnderOffer;
        if (isset($this->MbukSecured)) $o['MbukSecured'] = $this->MbukSecured;
        if (isset($this->HalfModelYearCode)) $o['HalfModelYearCode'] = $this->HalfModelYearCode;
        if (isset($this->FullModelYearCode)) $o['FullModelYearCode'] = $this->FullModelYearCode;
        if (isset($this->ProductionDate)) $o['ProductionDate'] = $this->ProductionDate;
        if (isset($this->IsMotability)) $o['IsMotability'] = $this->IsMotability;
        return empty($o) ? new class(){} : $o;
    }
}

class GetBackOrderMatchAllCsvResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<BackOrderVehicleCsv>|null */
        public ?array $Vehicles=null
    ) {
    }

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

class GetBackOrderCsvMatchAllRequest extends GetBackOrderMatchRequest implements IGet, JsonSerializable
{
    /**
     * @param string $Guid
     */
    public function __construct(
        string $Guid=''
    ) {
        parent::__construct($Guid);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetBackOrderCsvMatchAllRequest 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.

GET /v1/backordercsv/match/all HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Vehicles":[{"VehicleType":"String","Vid":"String","Vin":"String","Fin":"String","CommissionNumber":"String","ChassisNumber":"String","Line":"String","Packages":["String"],"ModelYear":"String","ModelYearCode":"String","Description":"String","VehicleClass":"String","RetailPrice_ExVAT":"String","RetailPrice_IncVAT":0,"OTR":"String","ActualPrice":"String","BodyStyle":"String","Model":"String","Colour":"String","ColourGroup":"String","Fuel":"String","ProductRange":"String","Engine":"String","IsAMG":false,"Transmission":"String","Upholstery":"String","Nst":"String","BM7NST":"String","Acceleration":0,"BootCapacity":0,"TopSpeed":0,"DriveConcept":"String","CombustionPowerHp":0,"ElectricPowerKw":0,"ElectricPowerHp":0,"CombinedPowerKw":0,"CombinedPowerHP":0,"ElectricRange":0,"ElectricConsumption":0,"EmissionCombined":"String","EmissionExtraUrban":"String","EmissionUrban":"String","Emission":0,"EmissionDirective":"String","EnergyEfficiencyClass":"String","WltpCombined":0,"WltpLow":0,"WltpMedium":0,"WltpHigh":0,"WltpExtraHigh":0,"WltpEmissionCombined":0,"PortArrivalDate":"String","CreationDate":"\/Date(-62135596800000-0000)\/","LastUpdated":"\/Date(-62135596800000-0000)\/","IsDisplayStock":false,"DisplayStockAgent":"String","IsSpecialistCar":false,"Account":"String","Location":"String","CesarIdShipToParty":"String","VehicleUsageCode":"String","IsSellable":false,"UnderOffer":false,"MbukSecured":false,"HalfModelYearCode":"String","FullModelYearCode":"String","ProductionDate":"String","IsMotability":false}]}