| GET | /v1/{VehicleType}/Vehicle/Central | Get central vehicle data |
|---|
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 VehiclesByRetailerResponse
{
public vehicles: VehicleIdentifierData[] = [];
public constructor(init?: Partial<VehiclesByRetailerResponse>) { (Object as any).assign(this, init); }
}
export class CentralVehiclesRequest implements IGet, IDataShapedRequest
{
public vehicleType: string;
/** @description If specified, the API will shape the data in the response to only include the specified fields */
// @ApiMember(Description="If specified, the API will shape the data in the response to only include the specified fields", ParameterType="model")
public fields: string;
public constructor(init?: Partial<CentralVehiclesRequest>) { (Object as any).assign(this, init); }
}
TypeScript CentralVehiclesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/{VehicleType}/Vehicle/Central HTTP/1.1
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"vehicles":[{"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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","mileage":0,"tradeInDate":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","baumuster":"String","isMotability":false,"pipAdvanceRentalGross":0,"wpmsAdvanceRentalGross":0,"ispVehicleCustomerDescriptions":["String"]}]}