Mercedes.VehicleManagement.API

<back to all web services

VehicleDetailsRequest

Vehicle
Requires Authentication
The following routes are available for this service:
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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<VehicleDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.Shared.POCO.V3">
  <Vehicle>
    <Account>String</Account>
    <ActualPrice>0</ActualPrice>
    <Baumuster>String</Baumuster>
    <Bm7NST>String</Bm7NST>
    <BodyStyle>String</BodyStyle>
    <Colour>String</Colour>
    <ColourDescription>String</ColourDescription>
    <CommissionNumber>String</CommissionNumber>
    <Description>String</Description>
    <DisplayRetailer>String</DisplayRetailer>
    <ElectricConsumption>0</ElectricConsumption>
    <ElectricRange>0</ElectricRange>
    <FuelType>String</FuelType>
    <FullModelYearCode>String</FullModelYearCode>
    <ImageUrl>String</ImageUrl>
    <InBackOrderAccount>false</InBackOrderAccount>
    <IsAllocatedToBackOrder>false</IsAllocatedToBackOrder>
    <IsAvailableOnline>false</IsAvailableOnline>
    <IsSellable>false</IsSellable>
    <IsSpecialistCar>false</IsSpecialistCar>
    <IspVehicleCustomerDescriptions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </IspVehicleCustomerDescriptions>
    <Line>String</Line>
    <Location>String</Location>
    <Model>String</Model>
    <NST>String</NST>
    <OTRPrice>0</OTRPrice>
    <Package>String</Package>
    <Packages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Packages>
    <PortArrivalDate>0001-01-01T00:00:00</PortArrivalDate>
    <ProductionDate>String</ProductionDate>
    <RetailPrice_ExVAT>0</RetailPrice_ExVAT>
    <RetailerId>0</RetailerId>
    <Secured>false</Secured>
    <Transmission>String</Transmission>
    <TransmissionType>String</TransmissionType>
    <UnderOffer>false</UnderOffer>
    <Upholstery>String</Upholstery>
    <UpholsteryDescription>String</UpholsteryDescription>
    <UsageCode>String</UsageCode>
    <VehicleAuditDetails>
      <VehicleAuditDetails>
        <CreationDate>String</CreationDate>
        <Notes>String</Notes>
        <Status>false</Status>
        <UserId>String</UserId>
      </VehicleAuditDetails>
    </VehicleAuditDetails>
    <VehicleType>String</VehicleType>
    <Vin>String</Vin>
    <Engine>String</Engine>
  </Vehicle>
</VehicleDetailsResponse>