POST | /v1/AllAvailableVehicles/{vehicleType}/{includeBackOrderAccounts} | Get all available vehicles |
---|
export class BaseAllAvailableVehiclesRequest
{
public vehicleType: string;
public includeBackOrderAccounts: boolean;
public constructor(init?: Partial<BaseAllAvailableVehiclesRequest>) { (Object as any).assign(this, init); }
}
export class BasicBackOrderVehicle
{
public commissionNumber: string;
public description: string;
public model: string;
public colour: string;
public fuelType: string;
public transmission: string;
public packages: string;
public lines: string;
public upholstery: string;
public emissionCombined: string;
public actualPrice: number;
public usageCode: string;
public secured: boolean;
public account: string;
public securedTime?: string;
public securedReason?: string;
public securedByGasId?: string;
public securedDate?: string;
public constructor(init?: Partial<BasicBackOrderVehicle>) { (Object as any).assign(this, init); }
}
export class BackOrderVehicle extends BasicBackOrderVehicle
{
public id: number;
public vin: string;
public vehicleType: string;
public vid: string;
public fin: string;
public chassisNumber: string;
public modelYear: string;
public modelYearCode: string;
public halfModelYearCode: string;
public fullModelYearCode: string;
public salesDescriptionLong: string;
public vehicleClass: string;
public retailPrice_ExVAT: number;
public retailPrice_IncVAT: number;
public otr: number;
public bodyStyle: string;
public productRange: string;
public engine: string;
public isAMG: boolean;
public colourGroup: string;
public upholsteryCode: string;
public nst: string;
public bm7NST: string;
public acceleration?: number;
public bootCapacity?: number;
public topSpeed?: number;
public driveConcept: string;
public combustionPowerHp?: number;
public electricPowerKw?: number;
public electricPowerHp?: number;
public combinedPowerKw?: number;
public combinedPowerHP?: number;
public electricRange?: number;
public electricConsumption?: number;
public emission?: number;
public emissionDirective: string;
public emissionExtraUrban: string;
public emissionUrban: string;
public energyEfficiencyClass: string;
public wltpEmissionCombined: string;
public wltpCombined: string;
public wltpLow: string;
public wltpMedium: string;
public wltpHigh: string;
public wltpExtraHigh: string;
public productionDate?: string;
public portArrivalDate?: string;
public creationDate: string;
public lastUpdated?: string;
public isDisplayStock: boolean;
public displayStockAgent: string;
public isSpecialistCar: boolean;
public location: string;
public cesarIdShipToParty: string;
public isSellable: boolean;
public underOffer: boolean;
public baumuster: string;
public constructor(init?: Partial<BackOrderVehicle>) { super(init); (Object as any).assign(this, init); }
}
export class StockManagementResponse
{
public totalVehicles: number;
public vehicles: BackOrderVehicle[];
public constructor(init?: Partial<StockManagementResponse>) { (Object as any).assign(this, init); }
}
export class CampaignExclusion
{
public vin: string[] = [];
public commissionNumber: string[] = [];
public modelYearCode: string;
public equipmentCode: string;
public gssn: string[] = [];
public constructor(init?: Partial<CampaignExclusion>) { (Object as any).assign(this, init); }
}
export class RegistrationDate
{
public from: string;
public to: string;
public constructor(init?: Partial<RegistrationDate>) { (Object as any).assign(this, init); }
}
export class Age
{
public date: string;
public min: number;
public max: number;
public includePipelineStock: boolean;
public constructor(init?: Partial<Age>) { (Object as any).assign(this, init); }
}
export class PortArrivalDate
{
public pipelineStock: boolean;
public from: string;
public to: string;
public constructor(init?: Partial<PortArrivalDate>) { (Object as any).assign(this, init); }
}
export class VehicleSearchV3Criteria
{
public vin: string[] = [];
public model: number[] = [];
public fuel: number[] = [];
public transmission: number[] = [];
public engine: number[] = [];
public line: string[] = [];
public mappedLine: number[] = [];
public commissionNumber: string[] = [];
public vehicleType: string;
public exclusion: CampaignExclusion;
public regNo: string;
public includeOffline: boolean;
public registrationDate: RegistrationDate;
public age: Age;
public portArrivalDate: PortArrivalDate;
public isAvailableOnline?: boolean;
public isBackOrdered?: boolean;
public isSellable?: boolean;
public isUnderOffer?: boolean;
public mbukSecured?: boolean;
public account: string[] = [];
public baumuster: string[] = [];
public colours: number[] = [];
public upholstery: number[] = [];
public package: number[] = [];
public nst: string[] = [];
public usageCode: string[] = [];
public constructor(init?: Partial<VehicleSearchV3Criteria>) { (Object as any).assign(this, init); }
}
export class AllAvailableVehiclesByCriteriaRequest extends BaseAllAvailableVehiclesRequest implements IPost
{
public criteria: VehicleSearchV3Criteria;
public constructor(init?: Partial<AllAvailableVehiclesByCriteriaRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript AllAvailableVehiclesByCriteriaRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/AllAvailableVehicles/{vehicleType}/{includeBackOrderAccounts} HTTP/1.1
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
criteria:
{
vin:
[
String
],
model:
[
0
],
fuel:
[
0
],
transmission:
[
0
],
engine:
[
0
],
line:
[
String
],
mappedLine:
[
0
],
commissionNumber:
[
String
],
vehicleType: String,
exclusion:
{
vin:
[
String
],
commissionNumber:
[
String
],
modelYearCode: String,
equipmentCode: String,
gssn:
[
String
]
},
regNo: String,
includeOffline: False,
registrationDate:
{
from: 0001-01-01,
to: 0001-01-01
},
age:
{
date: 0001-01-01,
min: 0,
max: 0,
includePipelineStock: False
},
portArrivalDate:
{
pipelineStock: False,
from: 0001-01-01,
to: 0001-01-01
},
isAvailableOnline: False,
isBackOrdered: False,
isSellable: False,
isUnderOffer: False,
mbukSecured: False,
account:
[
String
],
baumuster:
[
String
],
colours:
[
0
],
upholstery:
[
0
],
package:
[
0
],
nst:
[
String
],
usageCode:
[
String
]
},
vehicleType: String,
includeBackOrderAccounts: False
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { "totalVehicles": 0, "vehicles": null }