| GET | /v1/details/{vehicleType}/{Identifier} | Get Vehicle Details | |
|---|---|---|---|
| GET | /details/{vehicleType}/{Identifier} | Get Vehicle Details |
"use strict";
export class VehicleAuditDetails {
/** @param {{userId?:string,status?:boolean,notes?:string,creationDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
userId;
/** @type {boolean} */
status;
/** @type {string} */
notes;
/** @type {string} */
creationDate;
}
export class BackOrderVehicleDetailsBase {
/** @param {{vin?:string,commissionNumber?:string,description?:string,model?:string,fullModelYearCode?:string,retailerId?:number,imageUrl?:string,colour?:string,colourDescription?:string,bodyStyle?:string,fuelType?:string,transmission?:string,transmissionType?:string,package?:string,packages?:string[],line?:string,upholstery?:string,upholsteryDescription?:string,usageCode?:string,account?:string,nst?:string,baumuster?:string,electricRange?:number,electricConsumption?:number,retailPrice_ExVAT?:number,actualPrice?:number,otrPrice?:number,vehicleType?:string,secured?:boolean,productionDate?:string,portArrivalDate?:string,displayRetailer?:string,location?:string,bm7NST?:string,isAvailableOnline?:boolean,isSpecialistCar?:boolean,isSellable?:boolean,inBackOrderAccount?:boolean,vehicleAuditDetails?:VehicleAuditDetails[],ispVehicleCustomerDescriptions?:string[],underOffer?:boolean,isAllocatedToBackOrder?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
vin;
/** @type {string} */
commissionNumber;
/** @type {string} */
description;
/** @type {string} */
model;
/** @type {string} */
fullModelYearCode;
/** @type {number} */
retailerId;
/** @type {string} */
imageUrl;
/** @type {string} */
colour;
/** @type {string} */
colourDescription;
/** @type {string} */
bodyStyle;
/** @type {string} */
fuelType;
/** @type {string} */
transmission;
/** @type {string} */
transmissionType;
/** @type {string} */
package;
/** @type {string[]} */
packages = [];
/** @type {string} */
line;
/** @type {string} */
upholstery;
/** @type {string} */
upholsteryDescription;
/** @type {string} */
usageCode;
/** @type {string} */
account;
/** @type {string} */
nst;
/** @type {string} */
baumuster;
/** @type {?number} */
electricRange;
/** @type {?number} */
electricConsumption;
/** @type {number} */
retailPrice_ExVAT;
/** @type {?number} */
actualPrice;
/** @type {number} */
otrPrice;
/** @type {string} */
vehicleType;
/** @type {boolean} */
secured;
/** @type {string} */
productionDate;
/** @type {?string} */
portArrivalDate;
/** @type {string} */
displayRetailer;
/** @type {string} */
location;
/** @type {string} */
bm7NST;
/** @type {boolean} */
isAvailableOnline;
/** @type {boolean} */
isSpecialistCar;
/** @type {boolean} */
isSellable;
/** @type {boolean} */
inBackOrderAccount;
/** @type {VehicleAuditDetails[]} */
vehicleAuditDetails = [];
/** @type {?string[]} */
ispVehicleCustomerDescriptions;
/** @type {boolean} */
underOffer;
/** @type {boolean} */
isAllocatedToBackOrder;
}
export class BackOrderVehicleDetails extends BackOrderVehicleDetailsBase {
/** @param {{engine?:string,vin?:string,commissionNumber?:string,description?:string,model?:string,fullModelYearCode?:string,retailerId?:number,imageUrl?:string,colour?:string,colourDescription?:string,bodyStyle?:string,fuelType?:string,transmission?:string,transmissionType?:string,package?:string,packages?:string[],line?:string,upholstery?:string,upholsteryDescription?:string,usageCode?:string,account?:string,nst?:string,baumuster?:string,electricRange?:number,electricConsumption?:number,retailPrice_ExVAT?:number,actualPrice?:number,otrPrice?:number,vehicleType?:string,secured?:boolean,productionDate?:string,portArrivalDate?:string,displayRetailer?:string,location?:string,bm7NST?:string,isAvailableOnline?:boolean,isSpecialistCar?:boolean,isSellable?:boolean,inBackOrderAccount?:boolean,vehicleAuditDetails?:VehicleAuditDetails[],ispVehicleCustomerDescriptions?:string[],underOffer?:boolean,isAllocatedToBackOrder?:boolean}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?string} */
engine;
}
export class VehicleDetailsResponse {
/** @param {{vehicle?:BackOrderVehicleDetails}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {BackOrderVehicleDetails} */
vehicle;
}
export class VehicleDetailsRequest {
/** @param {{identifier?:string,vehicleType?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
identifier;
/** @type {string} */
vehicleType;
}
JavaScript VehicleDetailsRequest 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.
GET /v1/details/{vehicleType}/{Identifier} HTTP/1.1
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
vehicle:
{
engine: String,
vin: String,
commissionNumber: String,
description: String,
model: String,
fullModelYearCode: String,
retailerId: 0,
imageUrl: String,
colour: String,
colourDescription: String,
bodyStyle: String,
fuelType: String,
transmission: String,
transmissionType: String,
package: String,
packages:
[
String
],
line: String,
upholstery: String,
upholsteryDescription: String,
usageCode: String,
account: String,
nst: String,
baumuster: String,
electricRange: 0,
electricConsumption: 0,
retailPrice_ExVAT: 0,
actualPrice: 0,
otrPrice: 0,
vehicleType: String,
secured: False,
productionDate: String,
portArrivalDate: 0001-01-01,
displayRetailer: String,
location: String,
bm7NST: String,
isAvailableOnline: False,
isSpecialistCar: False,
isSellable: False,
inBackOrderAccount: False,
vehicleAuditDetails:
[
{
userId: String,
status: False,
notes: String,
creationDate: String
}
],
ispVehicleCustomerDescriptions:
[
String
],
underOffer: False,
isAllocatedToBackOrder: False
}
}