Mercedes.VehicleManagement.API

<back to all web services

CentralVehiclesRequest

Vehicle
Requires Authentication
The following routes are available for this service:
GET/v1/{VehicleType}/Vehicle/CentralGet central vehicle data
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Mercedes.VehicleManagement.API.ServiceModel;
using Mercedes.VehicleManagement.API.Shared.POCO;
using Mercedes.OS.Vehicle.Shared.POCO;

namespace Mercedes.OS.Vehicle.Shared.POCO
{
    public partial class Equipment
    {
        public virtual int Id { get; set; }
        public virtual string Code { get; set; }
        public virtual string Description { get; set; }
    }

}

namespace Mercedes.VehicleManagement.API.ServiceModel
{
    public partial class CentralVehiclesRequest
        : IGet, IDataShapedRequest
    {
        public virtual string VehicleType { get; set; }
        ///<summary>
        ///If specified, the API will shape the data in the response to only include the specified fields
        ///</summary>
        [ApiMember(Description="If specified, the API will shape the data in the response to only include the specified fields", ParameterType="model")]
        public virtual string Fields { get; set; }
    }

}

namespace Mercedes.VehicleManagement.API.Shared.POCO
{
    public partial class VehicleData
        : VehicleDataBase
    {
        public virtual string Engine { get; set; }
    }

    public partial class VehicleDataBase
    {
        public virtual string Vin { get; set; }
        public virtual string Description { get; set; }
        public virtual string Model { get; set; }
        public virtual string Otr { get; set; }
        public virtual string RetailPriceExVAT { get; set; }
        public virtual string ActualPrice { get; set; }
        public virtual string FuelType { get; set; }
        public virtual string Transmission { get; set; }
        public virtual string TransmissionType { get; set; }
        public virtual string Colour { get; set; }
        public virtual string ColourCode { get; set; }
        public virtual string ColourDescription { get; set; }
        public virtual string CommissionNumber { get; set; }
        public virtual bool OfferAvailable { get; set; }
        public virtual int CampaignDiscountOfferTotal { get; set; }
        public virtual int CampaignDiscountOfferTotalCurrent { get; set; }
        public virtual int CampaignDiscountOfferTotalPending { get; set; }
        public virtual int CampaignServiceOfferTotal { get; set; }
        public virtual int CampaignServiceOfferTotalCurrent { get; set; }
        public virtual int CampaignServiceOfferTotalPending { get; set; }
        public virtual int CampaignCustomOfferTotal { get; set; }
        public virtual int CampaignPersonalisedOfferTotalCurrent { get; set; }
        public virtual int CampaignPersonalisedOfferTotalPending { get; set; }
        public virtual int CampaignPersonalisedOfferTotal { get; set; }
        public virtual int CampaignCustomOfferTotalCurrent { get; set; }
        public virtual int CampaignCustomOfferTotalPending { get; set; }
        public virtual int CampaignOtherOfferTotal { get; set; }
        public virtual int CampaignOtherOfferTotalCurrent { get; set; }
        public virtual int CampaignOtherOfferTotalPending { get; set; }
        public virtual int RetailerDiscountOfferTotal { get; set; }
        public virtual int RetailerDiscountOfferTotalCurrent { get; set; }
        public virtual int RetailerDiscountOfferTotalPending { get; set; }
        public virtual int RetailerServiceOfferTotal { get; set; }
        public virtual int RetailerServiceOfferTotalCurrent { get; set; }
        public virtual int RetailerServiceOfferTotalPending { get; set; }
        public virtual int RetailerCustomOfferTotal { get; set; }
        public virtual int RetailerCustomOfferTotalCurrent { get; set; }
        public virtual int RetailerCustomOfferTotalPending { get; set; }
        public virtual int RetailerWarrantyOfferTotal { get; set; }
        public virtual int RetailerWarrantyOfferTotalCurrent { get; set; }
        public virtual int RetailerWarrantyOfferTotalPending { get; set; }
        public virtual int RetailerOfferTotal { get; set; }
        public virtual int RetailerOfferTotalCurrent { get; set; }
        public virtual int RetailerOfferTotalPending { get; set; }
        public virtual int CampaignOfferTotal { get; set; }
        public virtual int CampaignOfferTotalCurrent { get; set; }
        public virtual int CampaignOfferTotalPending { get; set; }
        public virtual int CampaignAndOfferTotal { get; set; }
        public virtual int CampaignAndOfferTotalCurrent { get; set; }
        public virtual int CampaignAndOfferTotalPending { get; set; }
        public virtual int OfferTotal { get; set; }
        public virtual int OfferTotalCurrent { get; set; }
        public virtual int OfferTotalPending { get; set; }
        public virtual string Creation { get; set; }
        public virtual string Modified { get; set; }
        public virtual int ElectricRange { get; set; }
        public virtual int ElectricConsumption { get; set; }
        public virtual DateTime? PortArrivalDate { get; set; }
        public virtual int? DaysSincePortArrival { get; set; }
        public virtual decimal RetailPriceIncVAT { get; set; }
        public virtual string BodyStyle { get; set; }
        public virtual string Upholstery { get; set; }
        public virtual string UpholsteryCode { get; set; }
        public virtual string UpholsteryType { get; set; }
        public virtual List<string> PackageNames { get; set; } = [];
        public virtual string Line { get; set; }
        public virtual decimal CurrentRetailerOfferPrice { get; set; }
        public virtual string RetailPrice { get; set; }
        public virtual bool VATQualifying { get; set; }
        public virtual int RetailerId { get; set; }
        public virtual string GssnId { get; set; }
        public virtual bool NoImage { get; set; }
        public virtual string ImageUrl { get; set; }
        public virtual bool IsAvailableOnline { get; set; }
        public virtual bool IsBackOrdered { get; set; }
        public virtual string CreationDate { get; set; }
        public virtual string MaintenanceDate { get; set; }
        public virtual string RegistrationNumber { get; set; }
        public virtual DateTime? RegistrationDate { get; set; }
        public virtual int? Mileage { get; set; }
        public virtual DateTime? TradeInDate { get; set; }
        public virtual string Source { get; set; }
        public virtual string VehicleType { get; set; }
        public virtual string OfferAmount { get; set; }
        public virtual string OfferExpiry { get; set; }
        public virtual int[] ActiveOffers { get; set; } = [];
        public virtual int CampaignMessagesTotal { get; set; }
        public virtual bool UnderOffer { get; set; }
        public virtual bool IsDisplayStock { get; set; }
        public virtual string DisplayRetailer { get; set; }
        public virtual string DisplayRetailerGssnId { get; set; }
        public virtual string Location { get; set; }
        public virtual string Account { get; set; }
        public virtual string AccountType { get; set; }
        public virtual string UsageCode { get; set; }
        public virtual string Bm7NST { get; set; }
        public virtual bool IsSellable { get; set; }
        public virtual bool Secured { get; set; }
        public virtual bool Specialist { get; set; }
        public virtual bool IsMotabilityRetailer { get; set; }
        public virtual string UpholsteryDescription { get; set; }
        public virtual bool InBackOrderAccount { get; set; }
        public virtual string FullModelYearCode { get; set; }
        public virtual DateTime? ProductionDate { get; set; }
        public virtual string Baumuster { get; set; }
        public virtual bool IsMotability { get; set; }
        public virtual decimal? PipAdvanceRentalGross { get; set; }
        public virtual decimal? WpmsAdvanceRentalGross { get; set; }
        public virtual List<string> IspVehicleCustomerDescriptions { get; set; }
    }

    public partial class VehicleIdentifierData
        : VehicleData
    {
        public virtual string Retailer { get; set; }
        public virtual bool HasMotabilityError { get; set; }
        public virtual List<Equipment> Equipment { get; set; } = [];
    }

    public partial class VehiclesByRetailerResponse
    {
        public virtual List<VehicleIdentifierData> Vehicles { get; set; } = [];
    }

}

C# 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>