Mercedes.VehicleManagement.API

CentralVehiclesRequest

Vehicle

The following routes are available for this service:
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 .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/{VehicleType}/Vehicle/Central 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>