| GET | /v1/{VehicleType}/Vehicle/{vehicleIdentifier} | Get vehicle data by commission number |
|---|
export class OfferVehicle
{
public retailPriceExVAT: string;
public constructor(init?: Partial<OfferVehicle>) { (Object as any).assign(this, init); }
}
export class Offer
{
public id: number;
public offerType: string;
public campaignName: string;
public from: string;
public to: string;
public value: string;
public net?: number;
public offerVehicle: OfferVehicle;
public pending: boolean;
public documentUrl: string;
public personalised: boolean;
public isPersonalisedMonetaryOffer: boolean;
public campaignVIPDiscount: boolean;
public offerValueNet?: number;
public constructor(init?: Partial<Offer>) { (Object as any).assign(this, init); }
}
export class PersonalisedOffer extends Offer
{
public category: string;
public description: string;
public reference: string;
public constructor(init?: Partial<PersonalisedOffer>) { super(init); (Object as any).assign(this, init); }
}
export class Message
{
public id: number;
public vin: string;
public campaignId: number;
public value: string;
public campaignDescription: string;
public from: string;
public to: string;
public documentUrl: string;
public constructor(init?: Partial<Message>) { (Object as any).assign(this, init); }
}
export class OfferHistory
{
public id: number;
public auditType: string;
public offerType: string;
public source: string;
public from: string;
public to: string;
public personalised: boolean;
public value: string;
public net: string;
public vat: string;
public description: string;
public vin: string;
public gssn: string;
public creation: string;
public modified: string;
public userId: string;
public user: number;
public offerId: number;
public commissionNumber: string;
public campaignId?: number;
public campaignDescription: string;
public creationDate: string;
public isUsedCarOffer: boolean;
public constructor(init?: Partial<OfferHistory>) { (Object as any).assign(this, init); }
}
export class FinanceOffer
{
public campaignDescription: string;
public termsAndConditions: string;
public label: string;
public campaignId: number;
public documentUrl: string;
public from: string;
public id: number;
public to: string;
public value: string;
public vin: string;
public enabled: boolean;
public pending: boolean;
public offerType: string;
public constructor(init?: Partial<FinanceOffer>) { (Object as any).assign(this, init); }
}
export class VehicleByIdentifierResponse
{
public campaignOffers: Offer[] = [];
public campaignPersonalisedOffers: PersonalisedOffer[] = [];
public campaignOLEVGrantOffers: Offer[] = [];
public campaignMessages: Message[] = [];
public offerHistories?: OfferHistory[];
public financeOffers?: FinanceOffer[];
public constructor(init?: Partial<VehicleByIdentifierResponse>) { (Object as any).assign(this, init); }
}
export class VehicleDataBase
{
public vin: string;
public description: string;
public model: string;
public otr: string;
public retailPriceExVAT: string;
public actualPrice: string;
public fuelType: string;
public transmission: string;
public transmissionType: string;
public colour: string;
public colourCode: string;
public colourDescription: string;
public commissionNumber: string;
public offerAvailable: boolean;
public campaignDiscountOfferTotal: number;
public campaignDiscountOfferTotalCurrent: number;
public campaignDiscountOfferTotalPending: number;
public campaignServiceOfferTotal: number;
public campaignServiceOfferTotalCurrent: number;
public campaignServiceOfferTotalPending: number;
public campaignCustomOfferTotal: number;
public campaignPersonalisedOfferTotalCurrent: number;
public campaignPersonalisedOfferTotalPending: number;
public campaignPersonalisedOfferTotal: number;
public campaignCustomOfferTotalCurrent: number;
public campaignCustomOfferTotalPending: number;
public campaignOtherOfferTotal: number;
public campaignOtherOfferTotalCurrent: number;
public campaignOtherOfferTotalPending: number;
public retailerDiscountOfferTotal: number;
public retailerDiscountOfferTotalCurrent: number;
public retailerDiscountOfferTotalPending: number;
public retailerServiceOfferTotal: number;
public retailerServiceOfferTotalCurrent: number;
public retailerServiceOfferTotalPending: number;
public retailerCustomOfferTotal: number;
public retailerCustomOfferTotalCurrent: number;
public retailerCustomOfferTotalPending: number;
public retailerWarrantyOfferTotal: number;
public retailerWarrantyOfferTotalCurrent: number;
public retailerWarrantyOfferTotalPending: number;
public retailerOfferTotal: number;
public retailerOfferTotalCurrent: number;
public retailerOfferTotalPending: number;
public campaignOfferTotal: number;
public campaignOfferTotalCurrent: number;
public campaignOfferTotalPending: number;
public campaignAndOfferTotal: number;
public campaignAndOfferTotalCurrent: number;
public campaignAndOfferTotalPending: number;
public offerTotal: number;
public offerTotalCurrent: number;
public offerTotalPending: number;
public creation: string;
public modified: string;
public electricRange: number;
public electricConsumption: number;
public portArrivalDate?: string;
public daysSincePortArrival?: number;
public retailPriceIncVAT: number;
public bodyStyle: string;
public upholstery: string;
public upholsteryCode: string;
public upholsteryType: string;
public packageNames: string[] = [];
public line: string;
public currentRetailerOfferPrice: number;
public retailPrice: string;
public vatQualifying: boolean;
public retailerId: number;
public gssnId: string;
public noImage: boolean;
public imageUrl: string;
public isAvailableOnline: boolean;
public isBackOrdered: boolean;
public creationDate: string;
public maintenanceDate: string;
public registrationNumber: string;
public registrationDate?: string;
public mileage?: number;
public tradeInDate?: string;
public source: string;
public vehicleType: string;
public offerAmount: string;
public offerExpiry: string;
public activeOffers: number[] = [];
public campaignMessagesTotal: number;
public underOffer: boolean;
public isDisplayStock: boolean;
public displayRetailer: string;
public displayRetailerGssnId: string;
public location: string;
public account: string;
public accountType: string;
public usageCode: string;
public bm7NST: string;
public isSellable: boolean;
public secured: boolean;
public specialist: boolean;
public isMotabilityRetailer: boolean;
public upholsteryDescription: string;
public inBackOrderAccount: boolean;
public fullModelYearCode?: string;
public productionDate?: string;
public baumuster: string;
public isMotability: boolean;
public pipAdvanceRentalGross?: number;
public wpmsAdvanceRentalGross?: number;
public ispVehicleCustomerDescriptions?: string[];
public constructor(init?: Partial<VehicleDataBase>) { (Object as any).assign(this, init); }
}
export class VehicleData extends VehicleDataBase
{
public engine: string;
public constructor(init?: Partial<VehicleData>) { super(init); (Object as any).assign(this, init); }
}
export class Equipment
{
public id: number;
public code?: string;
public description?: string;
public constructor(init?: Partial<Equipment>) { (Object as any).assign(this, init); }
}
export class VehicleIdentifierData extends VehicleData
{
public retailer: string;
public hasMotabilityError: boolean;
public equipment: Equipment[] = [];
public constructor(init?: Partial<VehicleIdentifierData>) { super(init); (Object as any).assign(this, init); }
}
export class VehicleByCommissionNumberResponse extends VehicleByIdentifierResponse
{
public vehicle: VehicleIdentifierData;
public constructor(init?: Partial<VehicleByCommissionNumberResponse>) { super(init); (Object as any).assign(this, init); }
}
export class VehicleByCommissionNumberRequest implements IGet
{
public vehicleIdentifier: string;
public vehicleType: string;
public constructor(init?: Partial<VehicleByCommissionNumberRequest>) { (Object as any).assign(this, init); }
}
TypeScript VehicleByCommissionNumberRequest 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/{VehicleType}/Vehicle/{vehicleIdentifier} 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:
{
retailer: String,
hasMotabilityError: False,
equipment:
[
{
id: 0,
code: String,
description: String
}
],
engine: String,
vin: String,
description: String,
model: String,
otr: String,
retailPriceExVAT: String,
actualPrice: String,
fuelType: String,
transmission: String,
transmissionType: String,
colour: String,
colourCode: String,
colourDescription: String,
commissionNumber: String,
offerAvailable: False,
campaignDiscountOfferTotal: 0,
campaignDiscountOfferTotalCurrent: 0,
campaignDiscountOfferTotalPending: 0,
campaignServiceOfferTotal: 0,
campaignServiceOfferTotalCurrent: 0,
campaignServiceOfferTotalPending: 0,
campaignCustomOfferTotal: 0,
campaignPersonalisedOfferTotalCurrent: 0,
campaignPersonalisedOfferTotalPending: 0,
campaignPersonalisedOfferTotal: 0,
campaignCustomOfferTotalCurrent: 0,
campaignCustomOfferTotalPending: 0,
campaignOtherOfferTotal: 0,
campaignOtherOfferTotalCurrent: 0,
campaignOtherOfferTotalPending: 0,
retailerDiscountOfferTotal: 0,
retailerDiscountOfferTotalCurrent: 0,
retailerDiscountOfferTotalPending: 0,
retailerServiceOfferTotal: 0,
retailerServiceOfferTotalCurrent: 0,
retailerServiceOfferTotalPending: 0,
retailerCustomOfferTotal: 0,
retailerCustomOfferTotalCurrent: 0,
retailerCustomOfferTotalPending: 0,
retailerWarrantyOfferTotal: 0,
retailerWarrantyOfferTotalCurrent: 0,
retailerWarrantyOfferTotalPending: 0,
retailerOfferTotal: 0,
retailerOfferTotalCurrent: 0,
retailerOfferTotalPending: 0,
campaignOfferTotal: 0,
campaignOfferTotalCurrent: 0,
campaignOfferTotalPending: 0,
campaignAndOfferTotal: 0,
campaignAndOfferTotalCurrent: 0,
campaignAndOfferTotalPending: 0,
offerTotal: 0,
offerTotalCurrent: 0,
offerTotalPending: 0,
creation: String,
modified: String,
electricRange: 0,
electricConsumption: 0,
portArrivalDate: 0001-01-01,
daysSincePortArrival: 0,
retailPriceIncVAT: 0,
bodyStyle: String,
upholstery: String,
upholsteryCode: String,
upholsteryType: String,
packageNames:
[
String
],
line: String,
currentRetailerOfferPrice: 0,
retailPrice: String,
vatQualifying: False,
retailerId: 0,
gssnId: String,
noImage: False,
imageUrl: String,
isAvailableOnline: False,
isBackOrdered: False,
creationDate: String,
maintenanceDate: String,
registrationNumber: String,
registrationDate: 0001-01-01,
mileage: 0,
tradeInDate: 0001-01-01,
source: String,
vehicleType: String,
offerAmount: String,
offerExpiry: String,
activeOffers:
[
0
],
campaignMessagesTotal: 0,
underOffer: False,
isDisplayStock: False,
displayRetailer: String,
displayRetailerGssnId: String,
location: String,
account: String,
accountType: String,
usageCode: String,
bm7NST: String,
isSellable: False,
secured: False,
specialist: False,
isMotabilityRetailer: False,
upholsteryDescription: String,
inBackOrderAccount: False,
fullModelYearCode: String,
productionDate: 0001-01-01,
baumuster: String,
isMotability: False,
pipAdvanceRentalGross: 0,
wpmsAdvanceRentalGross: 0,
ispVehicleCustomerDescriptions:
[
String
]
},
campaignOffers:
[
{
id: 0,
offerType: String,
campaignName: String,
from: String,
to: String,
value: String,
net: 0,
offerVehicle:
{
retailPriceExVAT: String
},
pending: False,
documentUrl: String,
personalised: False,
isPersonalisedMonetaryOffer: False,
campaignVIPDiscount: False,
offerValueNet: 0
}
],
campaignPersonalisedOffers:
[
{
category: String,
description: String,
reference: String,
id: 0,
offerType: String,
campaignName: String,
from: String,
to: String,
value: String,
net: 0,
offerVehicle:
{
retailPriceExVAT: String
},
pending: False,
documentUrl: String,
personalised: False,
isPersonalisedMonetaryOffer: False,
campaignVIPDiscount: False,
offerValueNet: 0
}
],
campaignOLEVGrantOffers:
[
{
id: 0,
offerType: String,
campaignName: String,
from: String,
to: String,
value: String,
net: 0,
offerVehicle:
{
retailPriceExVAT: String
},
pending: False,
documentUrl: String,
personalised: False,
isPersonalisedMonetaryOffer: False,
campaignVIPDiscount: False,
offerValueNet: 0
}
],
campaignMessages:
[
{
id: 0,
vin: String,
campaignId: 0,
value: String,
campaignDescription: String,
from: String,
to: String,
documentUrl: String
}
],
offerHistories:
[
{
id: 0,
auditType: String,
offerType: String,
source: String,
from: String,
to: String,
personalised: False,
value: String,
net: String,
vat: String,
description: String,
vin: String,
gssn: String,
creation: String,
modified: String,
userId: String,
user: 0,
offerId: 0,
commissionNumber: String,
campaignId: 0,
campaignDescription: String,
creationDate: 0001-01-01,
isUsedCarOffer: False
}
],
financeOffers:
[
{
campaignDescription: String,
termsAndConditions: String,
label: String,
campaignId: 0,
documentUrl: String,
from: String,
id: 0,
to: String,
value: String,
vin: String,
enabled: False,
pending: False,
offerType: String
}
]
}