GET | /v1/{VehicleType}/Vehicle/Motability | Get motability vehicle data |
---|
"use strict";
export class VehicleDataBase {
/** @param {{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?:boolean,campaignDiscountOfferTotal?:number,campaignDiscountOfferTotalCurrent?:number,campaignDiscountOfferTotalPending?:number,campaignServiceOfferTotal?:number,campaignServiceOfferTotalCurrent?:number,campaignServiceOfferTotalPending?:number,campaignCustomOfferTotal?:number,campaignPersonalisedOfferTotalCurrent?:number,campaignPersonalisedOfferTotalPending?:number,campaignPersonalisedOfferTotal?:number,campaignCustomOfferTotalCurrent?:number,campaignCustomOfferTotalPending?:number,campaignOtherOfferTotal?:number,campaignOtherOfferTotalCurrent?:number,campaignOtherOfferTotalPending?:number,retailerDiscountOfferTotal?:number,retailerDiscountOfferTotalCurrent?:number,retailerDiscountOfferTotalPending?:number,retailerServiceOfferTotal?:number,retailerServiceOfferTotalCurrent?:number,retailerServiceOfferTotalPending?:number,retailerCustomOfferTotal?:number,retailerCustomOfferTotalCurrent?:number,retailerCustomOfferTotalPending?:number,retailerWarrantyOfferTotal?:number,retailerWarrantyOfferTotalCurrent?:number,retailerWarrantyOfferTotalPending?:number,retailerOfferTotal?:number,retailerOfferTotalCurrent?:number,retailerOfferTotalPending?:number,campaignOfferTotal?:number,campaignOfferTotalCurrent?:number,campaignOfferTotalPending?:number,campaignAndOfferTotal?:number,campaignAndOfferTotalCurrent?:number,campaignAndOfferTotalPending?:number,offerTotal?:number,offerTotalCurrent?:number,offerTotalPending?:number,creation?:string,modified?:string,electricRange?:number,electricConsumption?:number,portArrivalDate?:string,daysSincePortArrival?:number,retailPriceIncVAT?:number,bodyStyle?:string,upholstery?:string,upholsteryCode?:string,upholsteryType?:string,packageNames?:string[],line?:string,currentRetailerOfferPrice?:number,retailPrice?:string,vatQualifying?:boolean,retailerId?:number,gssnId?:string,noImage?:boolean,imageUrl?:string,isAvailableOnline?:boolean,isBackOrdered?:boolean,creationDate?:string,maintenanceDate?:string,registrationNumber?:string,registrationDate?:string,mileage?:number,tradeInDate?:string,source?:string,vehicleType?:string,offerAmount?:string,offerExpiry?:string,activeOffers?:number[],campaignMessagesTotal?:number,underOffer?:boolean,isDisplayStock?:boolean,displayRetailer?:string,displayRetailerGssnId?:string,location?:string,account?:string,accountType?:string,usageCode?:string,bm7NST?:string,isSellable?:boolean,secured?:boolean,specialist?:boolean,isMotabilityRetailer?:boolean,upholsteryDescription?:string,inBackOrderAccount?:boolean,fullModelYearCode?:string,productionDate?:string,baumuster?:string,isMotability?:boolean,pipAdvanceRentalGross?:number,wpmsAdvanceRentalGross?:number,ispVehicleCustomerDescriptions?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
vin;
/** @type {string} */
description;
/** @type {string} */
model;
/** @type {string} */
otr;
/** @type {string} */
retailPriceExVAT;
/** @type {string} */
actualPrice;
/** @type {string} */
fuelType;
/** @type {string} */
transmission;
/** @type {string} */
transmissionType;
/** @type {string} */
colour;
/** @type {string} */
colourCode;
/** @type {string} */
colourDescription;
/** @type {string} */
commissionNumber;
/** @type {boolean} */
offerAvailable;
/** @type {number} */
campaignDiscountOfferTotal;
/** @type {number} */
campaignDiscountOfferTotalCurrent;
/** @type {number} */
campaignDiscountOfferTotalPending;
/** @type {number} */
campaignServiceOfferTotal;
/** @type {number} */
campaignServiceOfferTotalCurrent;
/** @type {number} */
campaignServiceOfferTotalPending;
/** @type {number} */
campaignCustomOfferTotal;
/** @type {number} */
campaignPersonalisedOfferTotalCurrent;
/** @type {number} */
campaignPersonalisedOfferTotalPending;
/** @type {number} */
campaignPersonalisedOfferTotal;
/** @type {number} */
campaignCustomOfferTotalCurrent;
/** @type {number} */
campaignCustomOfferTotalPending;
/** @type {number} */
campaignOtherOfferTotal;
/** @type {number} */
campaignOtherOfferTotalCurrent;
/** @type {number} */
campaignOtherOfferTotalPending;
/** @type {number} */
retailerDiscountOfferTotal;
/** @type {number} */
retailerDiscountOfferTotalCurrent;
/** @type {number} */
retailerDiscountOfferTotalPending;
/** @type {number} */
retailerServiceOfferTotal;
/** @type {number} */
retailerServiceOfferTotalCurrent;
/** @type {number} */
retailerServiceOfferTotalPending;
/** @type {number} */
retailerCustomOfferTotal;
/** @type {number} */
retailerCustomOfferTotalCurrent;
/** @type {number} */
retailerCustomOfferTotalPending;
/** @type {number} */
retailerWarrantyOfferTotal;
/** @type {number} */
retailerWarrantyOfferTotalCurrent;
/** @type {number} */
retailerWarrantyOfferTotalPending;
/** @type {number} */
retailerOfferTotal;
/** @type {number} */
retailerOfferTotalCurrent;
/** @type {number} */
retailerOfferTotalPending;
/** @type {number} */
campaignOfferTotal;
/** @type {number} */
campaignOfferTotalCurrent;
/** @type {number} */
campaignOfferTotalPending;
/** @type {number} */
campaignAndOfferTotal;
/** @type {number} */
campaignAndOfferTotalCurrent;
/** @type {number} */
campaignAndOfferTotalPending;
/** @type {number} */
offerTotal;
/** @type {number} */
offerTotalCurrent;
/** @type {number} */
offerTotalPending;
/** @type {string} */
creation;
/** @type {string} */
modified;
/** @type {number} */
electricRange;
/** @type {number} */
electricConsumption;
/** @type {?string} */
portArrivalDate;
/** @type {?number} */
daysSincePortArrival;
/** @type {number} */
retailPriceIncVAT;
/** @type {string} */
bodyStyle;
/** @type {string} */
upholstery;
/** @type {string} */
upholsteryCode;
/** @type {string} */
upholsteryType;
/** @type {string[]} */
packageNames = [];
/** @type {string} */
line;
/** @type {number} */
currentRetailerOfferPrice;
/** @type {string} */
retailPrice;
/** @type {boolean} */
vatQualifying;
/** @type {number} */
retailerId;
/** @type {string} */
gssnId;
/** @type {boolean} */
noImage;
/** @type {string} */
imageUrl;
/** @type {boolean} */
isAvailableOnline;
/** @type {boolean} */
isBackOrdered;
/** @type {string} */
creationDate;
/** @type {string} */
maintenanceDate;
/** @type {string} */
registrationNumber;
/** @type {?string} */
registrationDate;
/** @type {?number} */
mileage;
/** @type {?string} */
tradeInDate;
/** @type {string} */
source;
/** @type {string} */
vehicleType;
/** @type {string} */
offerAmount;
/** @type {string} */
offerExpiry;
/** @type {number[]} */
activeOffers = [];
/** @type {number} */
campaignMessagesTotal;
/** @type {boolean} */
underOffer;
/** @type {boolean} */
isDisplayStock;
/** @type {string} */
displayRetailer;
/** @type {string} */
displayRetailerGssnId;
/** @type {string} */
location;
/** @type {string} */
account;
/** @type {string} */
accountType;
/** @type {string} */
usageCode;
/** @type {string} */
bm7NST;
/** @type {boolean} */
isSellable;
/** @type {boolean} */
secured;
/** @type {boolean} */
specialist;
/** @type {boolean} */
isMotabilityRetailer;
/** @type {string} */
upholsteryDescription;
/** @type {boolean} */
inBackOrderAccount;
/** @type {?string} */
fullModelYearCode;
/** @type {?string} */
productionDate;
/** @type {string} */
baumuster;
/** @type {boolean} */
isMotability;
/** @type {?number} */
pipAdvanceRentalGross;
/** @type {?number} */
wpmsAdvanceRentalGross;
/** @type {?string[]} */
ispVehicleCustomerDescriptions;
}
export class VehicleData extends VehicleDataBase {
/** @param {{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?:boolean,campaignDiscountOfferTotal?:number,campaignDiscountOfferTotalCurrent?:number,campaignDiscountOfferTotalPending?:number,campaignServiceOfferTotal?:number,campaignServiceOfferTotalCurrent?:number,campaignServiceOfferTotalPending?:number,campaignCustomOfferTotal?:number,campaignPersonalisedOfferTotalCurrent?:number,campaignPersonalisedOfferTotalPending?:number,campaignPersonalisedOfferTotal?:number,campaignCustomOfferTotalCurrent?:number,campaignCustomOfferTotalPending?:number,campaignOtherOfferTotal?:number,campaignOtherOfferTotalCurrent?:number,campaignOtherOfferTotalPending?:number,retailerDiscountOfferTotal?:number,retailerDiscountOfferTotalCurrent?:number,retailerDiscountOfferTotalPending?:number,retailerServiceOfferTotal?:number,retailerServiceOfferTotalCurrent?:number,retailerServiceOfferTotalPending?:number,retailerCustomOfferTotal?:number,retailerCustomOfferTotalCurrent?:number,retailerCustomOfferTotalPending?:number,retailerWarrantyOfferTotal?:number,retailerWarrantyOfferTotalCurrent?:number,retailerWarrantyOfferTotalPending?:number,retailerOfferTotal?:number,retailerOfferTotalCurrent?:number,retailerOfferTotalPending?:number,campaignOfferTotal?:number,campaignOfferTotalCurrent?:number,campaignOfferTotalPending?:number,campaignAndOfferTotal?:number,campaignAndOfferTotalCurrent?:number,campaignAndOfferTotalPending?:number,offerTotal?:number,offerTotalCurrent?:number,offerTotalPending?:number,creation?:string,modified?:string,electricRange?:number,electricConsumption?:number,portArrivalDate?:string,daysSincePortArrival?:number,retailPriceIncVAT?:number,bodyStyle?:string,upholstery?:string,upholsteryCode?:string,upholsteryType?:string,packageNames?:string[],line?:string,currentRetailerOfferPrice?:number,retailPrice?:string,vatQualifying?:boolean,retailerId?:number,gssnId?:string,noImage?:boolean,imageUrl?:string,isAvailableOnline?:boolean,isBackOrdered?:boolean,creationDate?:string,maintenanceDate?:string,registrationNumber?:string,registrationDate?:string,mileage?:number,tradeInDate?:string,source?:string,vehicleType?:string,offerAmount?:string,offerExpiry?:string,activeOffers?:number[],campaignMessagesTotal?:number,underOffer?:boolean,isDisplayStock?:boolean,displayRetailer?:string,displayRetailerGssnId?:string,location?:string,account?:string,accountType?:string,usageCode?:string,bm7NST?:string,isSellable?:boolean,secured?:boolean,specialist?:boolean,isMotabilityRetailer?:boolean,upholsteryDescription?:string,inBackOrderAccount?:boolean,fullModelYearCode?:string,productionDate?:string,baumuster?:string,isMotability?:boolean,pipAdvanceRentalGross?:number,wpmsAdvanceRentalGross?:number,ispVehicleCustomerDescriptions?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
engine;
}
export class Equipment {
/** @param {{id?:number,code?:string,description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {?string} */
code;
/** @type {?string} */
description;
}
export class VehicleIdentifierData extends VehicleData {
/** @param {{retailer?:string,hasMotabilityError?:boolean,equipment?:Equipment[],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?:boolean,campaignDiscountOfferTotal?:number,campaignDiscountOfferTotalCurrent?:number,campaignDiscountOfferTotalPending?:number,campaignServiceOfferTotal?:number,campaignServiceOfferTotalCurrent?:number,campaignServiceOfferTotalPending?:number,campaignCustomOfferTotal?:number,campaignPersonalisedOfferTotalCurrent?:number,campaignPersonalisedOfferTotalPending?:number,campaignPersonalisedOfferTotal?:number,campaignCustomOfferTotalCurrent?:number,campaignCustomOfferTotalPending?:number,campaignOtherOfferTotal?:number,campaignOtherOfferTotalCurrent?:number,campaignOtherOfferTotalPending?:number,retailerDiscountOfferTotal?:number,retailerDiscountOfferTotalCurrent?:number,retailerDiscountOfferTotalPending?:number,retailerServiceOfferTotal?:number,retailerServiceOfferTotalCurrent?:number,retailerServiceOfferTotalPending?:number,retailerCustomOfferTotal?:number,retailerCustomOfferTotalCurrent?:number,retailerCustomOfferTotalPending?:number,retailerWarrantyOfferTotal?:number,retailerWarrantyOfferTotalCurrent?:number,retailerWarrantyOfferTotalPending?:number,retailerOfferTotal?:number,retailerOfferTotalCurrent?:number,retailerOfferTotalPending?:number,campaignOfferTotal?:number,campaignOfferTotalCurrent?:number,campaignOfferTotalPending?:number,campaignAndOfferTotal?:number,campaignAndOfferTotalCurrent?:number,campaignAndOfferTotalPending?:number,offerTotal?:number,offerTotalCurrent?:number,offerTotalPending?:number,creation?:string,modified?:string,electricRange?:number,electricConsumption?:number,portArrivalDate?:string,daysSincePortArrival?:number,retailPriceIncVAT?:number,bodyStyle?:string,upholstery?:string,upholsteryCode?:string,upholsteryType?:string,packageNames?:string[],line?:string,currentRetailerOfferPrice?:number,retailPrice?:string,vatQualifying?:boolean,retailerId?:number,gssnId?:string,noImage?:boolean,imageUrl?:string,isAvailableOnline?:boolean,isBackOrdered?:boolean,creationDate?:string,maintenanceDate?:string,registrationNumber?:string,registrationDate?:string,mileage?:number,tradeInDate?:string,source?:string,vehicleType?:string,offerAmount?:string,offerExpiry?:string,activeOffers?:number[],campaignMessagesTotal?:number,underOffer?:boolean,isDisplayStock?:boolean,displayRetailer?:string,displayRetailerGssnId?:string,location?:string,account?:string,accountType?:string,usageCode?:string,bm7NST?:string,isSellable?:boolean,secured?:boolean,specialist?:boolean,isMotabilityRetailer?:boolean,upholsteryDescription?:string,inBackOrderAccount?:boolean,fullModelYearCode?:string,productionDate?:string,baumuster?:string,isMotability?:boolean,pipAdvanceRentalGross?:number,wpmsAdvanceRentalGross?:number,ispVehicleCustomerDescriptions?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
retailer;
/** @type {boolean} */
hasMotabilityError;
/** @type {Equipment[]} */
equipment = [];
}
export class VehiclesByRetailerResponse {
/** @param {{vehicles?:VehicleIdentifierData[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {VehicleIdentifierData[]} */
vehicles = [];
}
export class MotabilityVehiclesRequest {
/** @param {{vehicleType?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
vehicleType;
}
JavaScript MotabilityVehiclesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/{VehicleType}/Vehicle/Motability HTTP/1.1 Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <VehiclesByRetailerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.Shared.POCO"> <Vehicles> <VehicleIdentifierData> <Account>String</Account> <AccountType>String</AccountType> <ActiveOffers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>0</d4p1:int> </ActiveOffers> <ActualPrice>String</ActualPrice> <Baumuster>String</Baumuster> <Bm7NST>String</Bm7NST> <BodyStyle>String</BodyStyle> <CampaignAndOfferTotal>0</CampaignAndOfferTotal> <CampaignAndOfferTotalCurrent>0</CampaignAndOfferTotalCurrent> <CampaignAndOfferTotalPending>0</CampaignAndOfferTotalPending> <CampaignCustomOfferTotal>0</CampaignCustomOfferTotal> <CampaignCustomOfferTotalCurrent>0</CampaignCustomOfferTotalCurrent> <CampaignCustomOfferTotalPending>0</CampaignCustomOfferTotalPending> <CampaignDiscountOfferTotal>0</CampaignDiscountOfferTotal> <CampaignDiscountOfferTotalCurrent>0</CampaignDiscountOfferTotalCurrent> <CampaignDiscountOfferTotalPending>0</CampaignDiscountOfferTotalPending> <CampaignMessagesTotal>0</CampaignMessagesTotal> <CampaignOfferTotal>0</CampaignOfferTotal> <CampaignOfferTotalCurrent>0</CampaignOfferTotalCurrent> <CampaignOfferTotalPending>0</CampaignOfferTotalPending> <CampaignOtherOfferTotal>0</CampaignOtherOfferTotal> <CampaignOtherOfferTotalCurrent>0</CampaignOtherOfferTotalCurrent> <CampaignOtherOfferTotalPending>0</CampaignOtherOfferTotalPending> <CampaignPersonalisedOfferTotal>0</CampaignPersonalisedOfferTotal> <CampaignPersonalisedOfferTotalCurrent>0</CampaignPersonalisedOfferTotalCurrent> <CampaignPersonalisedOfferTotalPending>0</CampaignPersonalisedOfferTotalPending> <CampaignServiceOfferTotal>0</CampaignServiceOfferTotal> <CampaignServiceOfferTotalCurrent>0</CampaignServiceOfferTotalCurrent> <CampaignServiceOfferTotalPending>0</CampaignServiceOfferTotalPending> <Colour>String</Colour> <ColourCode>String</ColourCode> <ColourDescription>String</ColourDescription> <CommissionNumber>String</CommissionNumber> <Creation>String</Creation> <CreationDate>String</CreationDate> <CurrentRetailerOfferPrice>0</CurrentRetailerOfferPrice> <DaysSincePortArrival>0</DaysSincePortArrival> <Description>String</Description> <DisplayRetailer>String</DisplayRetailer> <DisplayRetailerGssnId>String</DisplayRetailerGssnId> <ElectricConsumption>0</ElectricConsumption> <ElectricRange>0</ElectricRange> <FuelType>String</FuelType> <FullModelYearCode>String</FullModelYearCode> <GssnId>String</GssnId> <ImageUrl>String</ImageUrl> <InBackOrderAccount>false</InBackOrderAccount> <IsAvailableOnline>false</IsAvailableOnline> <IsBackOrdered>false</IsBackOrdered> <IsDisplayStock>false</IsDisplayStock> <IsMotability>false</IsMotability> <IsMotabilityRetailer>false</IsMotabilityRetailer> <IsSellable>false</IsSellable> <IspVehicleCustomerDescriptions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </IspVehicleCustomerDescriptions> <Line>String</Line> <Location>String</Location> <MaintenanceDate>String</MaintenanceDate> <Mileage>0</Mileage> <Model>String</Model> <Modified>String</Modified> <NoImage>false</NoImage> <OfferAmount>String</OfferAmount> <OfferAvailable>false</OfferAvailable> <OfferExpiry>String</OfferExpiry> <OfferTotal>0</OfferTotal> <OfferTotalCurrent>0</OfferTotalCurrent> <OfferTotalPending>0</OfferTotalPending> <Otr>String</Otr> <PackageNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </PackageNames> <PipAdvanceRentalGross>0</PipAdvanceRentalGross> <PortArrivalDate>0001-01-01T00:00:00</PortArrivalDate> <ProductionDate>0001-01-01T00:00:00</ProductionDate> <RegistrationDate>0001-01-01T00:00:00</RegistrationDate> <RegistrationNumber>String</RegistrationNumber> <RetailPrice>String</RetailPrice> <RetailPriceExVAT>String</RetailPriceExVAT> <RetailPriceIncVAT>0</RetailPriceIncVAT> <RetailerCustomOfferTotal>0</RetailerCustomOfferTotal> <RetailerCustomOfferTotalCurrent>0</RetailerCustomOfferTotalCurrent> <RetailerCustomOfferTotalPending>0</RetailerCustomOfferTotalPending> <RetailerDiscountOfferTotal>0</RetailerDiscountOfferTotal> <RetailerDiscountOfferTotalCurrent>0</RetailerDiscountOfferTotalCurrent> <RetailerDiscountOfferTotalPending>0</RetailerDiscountOfferTotalPending> <RetailerId>0</RetailerId> <RetailerOfferTotal>0</RetailerOfferTotal> <RetailerOfferTotalCurrent>0</RetailerOfferTotalCurrent> <RetailerOfferTotalPending>0</RetailerOfferTotalPending> <RetailerServiceOfferTotal>0</RetailerServiceOfferTotal> <RetailerServiceOfferTotalCurrent>0</RetailerServiceOfferTotalCurrent> <RetailerServiceOfferTotalPending>0</RetailerServiceOfferTotalPending> <RetailerWarrantyOfferTotal>0</RetailerWarrantyOfferTotal> <RetailerWarrantyOfferTotalCurrent>0</RetailerWarrantyOfferTotalCurrent> <RetailerWarrantyOfferTotalPending>0</RetailerWarrantyOfferTotalPending> <Secured>false</Secured> <Source>String</Source> <Specialist>false</Specialist> <TradeInDate>0001-01-01T00:00:00</TradeInDate> <Transmission>String</Transmission> <TransmissionType>String</TransmissionType> <UnderOffer>false</UnderOffer> <Upholstery>String</Upholstery> <UpholsteryCode>String</UpholsteryCode> <UpholsteryDescription>String</UpholsteryDescription> <UpholsteryType>String</UpholsteryType> <UsageCode>String</UsageCode> <VATQualifying>false</VATQualifying> <VehicleType>String</VehicleType> <Vin>String</Vin> <WpmsAdvanceRentalGross>0</WpmsAdvanceRentalGross> <Engine>String</Engine> <Equipment xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO"> <d4p1:Equipment> <d4p1:Code>String</d4p1:Code> <d4p1:Description>String</d4p1:Description> <d4p1:Id>0</d4p1:Id> </d4p1:Equipment> </Equipment> <HasMotabilityError>false</HasMotabilityError> <Retailer>String</Retailer> </VehicleIdentifierData> </Vehicles> </VehiclesByRetailerResponse>