| POST | /v1/AllAvailableVehiclesCsv/{vehicleType}/{includeBackOrderAccounts} | Get all available vehicles |
|---|
"use strict";
export class BaseAllAvailableVehiclesRequest {
/** @param {{vehicleType?:string,includeBackOrderAccounts?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
vehicleType;
/** @type {boolean} */
includeBackOrderAccounts;
}
export class CsvVehicle {
/** @param {{Vehicle_Type?:string,vid?:string,vin?:string,fin?:string,Comm?:string,Chassis_Number?:string,Model_Year?:string,Model_Year_Code?:string,Half_Model_Year_Code?:string,Full_Model_Year_Code?:string,Description?:string,Vehicle_Class?:string,Body_Style?:string,model?:string,colour?:string,Colour_Group?:string,Fuel_Type?:string,transmission?:string,packages?:string,lines?:string,Product_Range?:string,engine?:string,isAMG?:boolean,upholstery?:string,nst?:string,baumuster?:string,bm7NST?:string,acceleration?:number,Boot_Capacity?:number,Top_Speed?:number,Drive_Concept?:string,Combustion_Power_HP?:number,Electric_Power_KW?:number,Electric_Power_HP?:number,Combined_Power_KW?:number,Combined_Power_HP?:number,Electric_Range?:number,Electric_Consumption?:number,Emission_Combined?:string,Emission_Directive?:string,Emission_Extra_Urban?:string,Emission_Urban?:string,emission?:number,Test_Standard?:string,Energy_Efficiency_Class?:string,WLTP_Combined?:string,WLTP_Low?:string,WLTP_Medium?:string,WLTP_High?:string,WLTP_Extra_High?:string,WLTP_CO2_Emissions?:string,Production_Date?:string,Port_Arrival_Date?:string,Creation_Date?:string,Maintenance_Date?:string,Net_Price?:number,Retail_Price?:number,OTR_Price?:number,Actual_Price?:number,Usage_Code?:string,secured?:string,account?:string,isDisplayStock?:string,Display_Agent?:string,isSpecialistCar?:string,cesarIdShipToParty?:string,isSellable?:string,Under_Offer?:string,Secured_Date?:string,Secured_Reason?:string,Secured_By_Gas_Id?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Vehicle_Type;
/** @type {string} */
vid;
/** @type {string} */
vin;
/** @type {string} */
fin;
/** @type {string} */
Comm;
/** @type {string} */
Chassis_Number;
/** @type {string} */
Model_Year;
/** @type {string} */
Model_Year_Code;
/** @type {string} */
Half_Model_Year_Code;
/** @type {string} */
Full_Model_Year_Code;
/** @type {string} */
Description;
/** @type {string} */
Vehicle_Class;
/** @type {string} */
Body_Style;
/** @type {string} */
model;
/** @type {string} */
colour;
/** @type {string} */
Colour_Group;
/** @type {string} */
Fuel_Type;
/** @type {string} */
transmission;
/** @type {string} */
packages;
/** @type {string} */
lines;
/** @type {string} */
Product_Range;
/** @type {string} */
engine;
/** @type {boolean} */
isAMG;
/** @type {string} */
upholstery;
/** @type {string} */
nst;
/** @type {string} */
baumuster;
/** @type {string} */
bm7NST;
/** @type {?number} */
acceleration;
/** @type {?number} */
Boot_Capacity;
/** @type {?number} */
Top_Speed;
/** @type {string} */
Drive_Concept;
/** @type {?number} */
Combustion_Power_HP;
/** @type {?number} */
Electric_Power_KW;
/** @type {?number} */
Electric_Power_HP;
/** @type {?number} */
Combined_Power_KW;
/** @type {?number} */
Combined_Power_HP;
/** @type {?number} */
Electric_Range;
/** @type {?number} */
Electric_Consumption;
/** @type {string} */
Emission_Combined;
/** @type {string} */
Emission_Directive;
/** @type {string} */
Emission_Extra_Urban;
/** @type {string} */
Emission_Urban;
/** @type {?number} */
emission;
/** @type {string} */
Test_Standard;
/** @type {string} */
Energy_Efficiency_Class;
/** @type {string} */
WLTP_Combined;
/** @type {string} */
WLTP_Low;
/** @type {string} */
WLTP_Medium;
/** @type {string} */
WLTP_High;
/** @type {string} */
WLTP_Extra_High;
/** @type {string} */
WLTP_CO2_Emissions;
/** @type {?string} */
Production_Date;
/** @type {?string} */
Port_Arrival_Date;
/** @type {string} */
Creation_Date;
/** @type {?string} */
Maintenance_Date;
/** @type {number} */
Net_Price;
/** @type {number} */
Retail_Price;
/** @type {number} */
OTR_Price;
/** @type {number} */
Actual_Price;
/** @type {string} */
Usage_Code;
/** @type {string} */
secured;
/** @type {string} */
account;
/** @type {string} */
isDisplayStock;
/** @type {string} */
Display_Agent;
/** @type {string} */
isSpecialistCar;
/** @type {string} */
cesarIdShipToParty;
/** @type {string} */
isSellable;
/** @type {string} */
Under_Offer;
/** @type {?string} */
Secured_Date;
/** @type {?string} */
Secured_Reason;
/** @type {?string} */
Secured_By_Gas_Id;
}
export class InternalAvailableStockResponse {
/** @param {{totalVehicles?:number,vehicles?:CsvVehicle[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
totalVehicles;
/** @type {CsvVehicle[]} */
vehicles;
}
export class CampaignExclusion {
/** @param {{vin?:string[],commissionNumber?:string[],modelYearCode?:string,equipmentCode?:string,gssn?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string[]} */
vin = [];
/** @type {string[]} */
commissionNumber = [];
/** @type {string} */
modelYearCode;
/** @type {string} */
equipmentCode;
/** @type {string[]} */
gssn = [];
}
export class RegistrationDate {
/** @param {{from?:string,to?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
from;
/** @type {string} */
to;
}
export class Age {
/** @param {{date?:string,min?:number,max?:number,includePipelineStock?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
date;
/** @type {number} */
min;
/** @type {number} */
max;
/** @type {boolean} */
includePipelineStock;
}
export class PortArrivalDate {
/** @param {{pipelineStock?:boolean,from?:string,to?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
pipelineStock;
/** @type {string} */
from;
/** @type {string} */
to;
}
export class VehicleSearchV3Criteria {
/** @param {{vin?:string[],model?:number[],fuel?:number[],transmission?:number[],engine?:number[],line?:string[],mappedLine?:number[],commissionNumber?:string[],vehicleType?:string,exclusion?:CampaignExclusion,regNo?:string,includeOffline?:boolean,registrationDate?:RegistrationDate,age?:Age,portArrivalDate?:PortArrivalDate,isAvailableOnline?:boolean,isBackOrdered?:boolean,isSellable?:boolean,isUnderOffer?:boolean,mbukSecured?:boolean,account?:string[],baumuster?:string[],colours?:number[],upholstery?:number[],package?:number[],nst?:string[],usageCode?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string[]} */
vin = [];
/** @type {number[]} */
model = [];
/** @type {number[]} */
fuel = [];
/** @type {number[]} */
transmission = [];
/** @type {number[]} */
engine = [];
/** @type {string[]} */
line = [];
/** @type {number[]} */
mappedLine = [];
/** @type {string[]} */
commissionNumber = [];
/** @type {string} */
vehicleType;
/** @type {CampaignExclusion} */
exclusion;
/** @type {string} */
regNo;
/** @type {boolean} */
includeOffline;
/** @type {RegistrationDate} */
registrationDate;
/** @type {Age} */
age;
/** @type {PortArrivalDate} */
portArrivalDate;
/** @type {?boolean} */
isAvailableOnline;
/** @type {?boolean} */
isBackOrdered;
/** @type {?boolean} */
isSellable;
/** @type {?boolean} */
isUnderOffer;
/** @type {?boolean} */
mbukSecured;
/** @type {string[]} */
account = [];
/** @type {string[]} */
baumuster = [];
/** @type {number[]} */
colours = [];
/** @type {number[]} */
upholstery = [];
/** @type {number[]} */
package = [];
/** @type {string[]} */
nst = [];
/** @type {string[]} */
usageCode = [];
}
export class AllAvailableVehiclesByCriteriaCsvRequest extends BaseAllAvailableVehiclesRequest {
/** @param {{criteria?:VehicleSearchV3Criteria,vehicleType?:string,includeBackOrderAccounts?:boolean}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {VehicleSearchV3Criteria} */
criteria;
}
JavaScript AllAvailableVehiclesByCriteriaCsvRequest 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/AllAvailableVehiclesCsv/{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
}