| POST | /v1/AllAvailableVehiclesCsv/{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 CsvVehicle
{
// @DataMember(Name="Vehicle Type")
public Vehicle_Type: string;
public vid: string;
public vin: string;
public fin: string;
// @DataMember(Name="Comm")
public Comm: string;
// @DataMember(Name="Chassis Number")
public Chassis_Number: string;
// @DataMember(Name="Model Year")
public Model_Year: string;
// @DataMember(Name="Model Year Code")
public Model_Year_Code: string;
// @DataMember(Name="Half Model Year Code")
public Half_Model_Year_Code: string;
// @DataMember(Name="Full Model Year Code")
public Full_Model_Year_Code: string;
// @DataMember(Name="Description")
public Description: string;
// @DataMember(Name="Vehicle Class")
public Vehicle_Class: string;
// @DataMember(Name="Body Style")
public Body_Style: string;
public model: string;
public colour: string;
// @DataMember(Name="Colour Group")
public Colour_Group: string;
// @DataMember(Name="Fuel Type")
public Fuel_Type: string;
public transmission: string;
public packages: string;
public lines: string;
// @DataMember(Name="Product Range")
public Product_Range: string;
public engine: string;
public isAMG: boolean;
public upholstery: string;
public nst: string;
public baumuster: string;
public bm7NST: string;
public acceleration?: number;
// @DataMember(Name="Boot Capacity")
public Boot_Capacity?: number;
// @DataMember(Name="Top Speed")
public Top_Speed?: number;
// @DataMember(Name="Drive Concept")
public Drive_Concept: string;
// @DataMember(Name="Combustion Power HP")
public Combustion_Power_HP?: number;
// @DataMember(Name="Electric Power KW")
public Electric_Power_KW?: number;
// @DataMember(Name="Electric Power HP")
public Electric_Power_HP?: number;
// @DataMember(Name="Combined Power KW")
public Combined_Power_KW?: number;
// @DataMember(Name="Combined Power HP")
public Combined_Power_HP?: number;
// @DataMember(Name="Electric Range")
public Electric_Range?: number;
// @DataMember(Name="Electric Consumption")
public Electric_Consumption?: number;
// @DataMember(Name="Emission Combined")
public Emission_Combined: string;
// @DataMember(Name="Emission Directive")
public Emission_Directive: string;
// @DataMember(Name="Emission Extra Urban")
public Emission_Extra_Urban: string;
// @DataMember(Name="Emission Urban")
public Emission_Urban: string;
public emission?: number;
// @DataMember(Name="Test Standard")
public Test_Standard: string;
// @DataMember(Name="Energy Efficiency Class")
public Energy_Efficiency_Class: string;
// @DataMember(Name="WLTP Combined")
public WLTP_Combined: string;
// @DataMember(Name="WLTP Low")
public WLTP_Low: string;
// @DataMember(Name="WLTP Medium")
public WLTP_Medium: string;
// @DataMember(Name="WLTP High")
public WLTP_High: string;
// @DataMember(Name="WLTP Extra High")
public WLTP_Extra_High: string;
// @DataMember(Name="WLTP CO2 Emissions")
public WLTP_CO2_Emissions: string;
// @DataMember(Name="Production Date")
public Production_Date?: string;
// @DataMember(Name="Port Arrival Date")
public Port_Arrival_Date?: string;
// @DataMember(Name="Creation Date")
public Creation_Date: string;
// @DataMember(Name="Maintenance Date")
public Maintenance_Date?: string;
// @DataMember(Name="Net Price")
public Net_Price: number;
// @DataMember(Name="Retail Price")
public Retail_Price: number;
// @DataMember(Name="OTR Price")
public OTR_Price: number;
// @DataMember(Name="Actual Price")
public Actual_Price: number;
// @DataMember(Name="Usage Code")
public Usage_Code: string;
public secured: string;
public account: string;
public isDisplayStock: string;
// @DataMember(Name="Display Agent")
public Display_Agent: string;
public isSpecialistCar: string;
public cesarIdShipToParty: string;
public isSellable: string;
// @DataMember(Name="Under Offer")
public Under_Offer: string;
// @DataMember(Name="Secured Date")
public Secured_Date?: string;
// @DataMember(Name="Secured Reason")
public Secured_Reason?: string;
// @DataMember(Name="Secured By Gas Id")
public Secured_By_Gas_Id?: string;
public constructor(init?: Partial<CsvVehicle>) { (Object as any).assign(this, init); }
}
export class InternalAvailableStockResponse
{
public totalVehicles: number;
public vehicles: CsvVehicle[];
public constructor(init?: Partial<InternalAvailableStockResponse>) { (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 AllAvailableVehiclesByCriteriaCsvRequest extends BaseAllAvailableVehiclesRequest implements IPost
{
public criteria: VehicleSearchV3Criteria;
public constructor(init?: Partial<AllAvailableVehiclesByCriteriaCsvRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript 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
}