Mercedes.Agency.Orchestration.API

GetVehicleRequest

Vehicle

The following routes are available for this service:
POST	/v1/vehicle	Get Vehicle by Vin	Get Vehicle by Vin

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetVehicleRequest
{
    open var Vin:String? = null
    open var IncludeAllocatedToOrder:Boolean? = null
    open var Gssn:String? = null
    open var IsOneAdmin:Boolean? = null
}

open class GetVehicleResponse
{
    open var Vehicle:VehicleDetailDto? = null
    open var Errors:ArrayList<VehicleError>? = null
}

open class VehicleDetailDto
{
    open var BodyStyle:String? = null
    open var Vin:String? = null
    open var Description:String? = null
    open var Colour:String? = null
    open var ColourCode:String? = null
    open var ColourDescription:String? = null
    open var ColourGroup:String? = null
    open var Model:String? = null
    open var CommissionNumber:String? = null
    open var BrandId:Int? = null
    open var Brand:Brand? = null
    open var Engine:Engine? = null
    open var EngineBadge:String? = null
    open var Media:Media? = null
    open var Line:String? = null
    open var UpholsteryCode:String? = null
    open var UpholsteryType:String? = null
    open var Upholstery:String? = null
    open var UpholsteryDescription:String? = null
    open var AvailablePackages:ArrayList<String> = ArrayList<String>()
    open var Packages:ArrayList<String> = ArrayList<String>()
    open var P11D:BigDecimal? = null
    open var PortArrivalDate:Date? = null
    open var Prices:ArrayList<Price> = ArrayList<Price>()
    open var TransmissionType:String? = null
    open var FuelType:String? = null
    open var VehicleClass:String? = null
    open var ProductRange:String? = null
    open var VehicleType:String? = null
    open var Emission:BigDecimal? = null
    open var IsAvailableOnline:Boolean? = null
    open var UnderOffer:Boolean? = null
    open var IsExcluded:Boolean? = null
    open var IsSellable:Boolean? = null
    open var OnHold:Boolean? = null
    open var ElectricConsumption:BigDecimal? = null
    open var ElectricRange:BigDecimal? = null
    open var ImageUrl:String? = null
    open var Baumuster:String? = null
    open var Retailer:Retailer? = null
    open var Bm7NST:String? = null
    open var OTR:BigDecimal? = null
    open var ActualPrice:BigDecimal? = null
    open var IsDisplayStock:Boolean? = null
    open var DisplayRetailerId:Int? = null
    open var DisplayRetailer:String? = null
    open var DisplayRetailerGssnId:String? = null
    open var DisplayRetailerMarketAreaId:String? = null
    open var IsSmartDisplayRetailer:Boolean? = null
    open var IsSpecialistCar:Boolean? = null
    open var Age:Int? = null
    open var Secured:Boolean? = null
    open var IsHOBackOrderAccountVehicle:Boolean? = null
    open var IsAllocatedToBackOrder:Boolean? = null
    open var UsageCode:String? = null
    open var EmissionCombined:BigDecimal? = null
    open var NormalisedEmissionDirective:String? = null
    open var HasMildHybridEquipmentCode:Boolean? = null
    open var RetailPriceExVat:BigDecimal? = null
    open var RetailPrice_IncVAT:BigDecimal? = null
    open var RetailPrice_ExVAT:BigDecimal? = null
    open var ModelId:Int? = null
    open var VID:String? = null
    open var ProductionDate:String? = null
    open var FullModelYearCode:String? = null
    open var ChassisNumber:String? = null
    open var EligibleForIntegratedServiceCare:Boolean? = null
    open var AccountType:String? = null
    open var ConsumptionCombined:VehicleConsumption? = null
    open var ConsumptionExtraUrban:VehicleConsumption? = null
    open var ConsumptionUrban:VehicleConsumption? = null
    open var WltpFuelConsumptionCombined:VehicleConsumption? = null
    open var WltpFuelConsumptionExtraHigh:VehicleConsumption? = null
    open var WltpFuelConsumptionHigh:VehicleConsumption? = null
    open var WltpFuelConsumptionLow:VehicleConsumption? = null
    open var WltpFuelConsumptionMedium:VehicleConsumption? = null
    open var Equipment:ArrayList<Equipmentv2>? = null
    open var EquipmentCategories:ArrayList<VehicleEquipmentCategory>? = null
    open var EnergyEfficiencyClass:VehicleEmissionClass? = null
    open var VehicleData:ArrayList<VehicleAttribute>? = null
    open var IntegratedServiceCareOptions:ArrayList<VehicleIntegratedServiceCareOption> = ArrayList<VehicleIntegratedServiceCareOption>()
    open var IspVehicleCustomerDescriptions:ArrayList<String>? = null
    open var ConfirmedProductionDate:String? = null
    open var ForecastedArrivalDate:String? = null
}

open class Brand
{
    open var Id:Int? = null
    open var Description:String? = null
    open var DisplayName:String? = null
    open var BodyStyles:ArrayList<BodyStyle>? = null
}

open class BodyStyle
{
    open var Id:Int? = null
    open var Description:String? = null
    open var Models:ArrayList<Model>? = null
}

open class Model
{
    open var Id:Int? = null
    open var Description:String? = null
    open var DisplayName:String? = null
    open var ImageUrlSmall:String? = null
    open var ImageUrlMedium:String? = null
    open var ImageUrlLarge:String? = null
    open var Specialist:Boolean? = null
    open var Priority:Int? = null
    open var ExcludeFromOnlineShowroomFilters:Boolean? = null
}

open class Engine
{
    open var Id:Int? = null
    open var Badge:String? = null
}

open class Media
{
    open var NoImage:Boolean? = null
    open var MainImageUrl:String? = null
}

open class Price
{
    open var Id:String? = null
    open var Description:String? = null
    open var Net:BigDecimal? = null
    open var VAT:BigDecimal? = null
    open var Gross:BigDecimal? = null
    open var Product:OfferPriceProductType? = null
}

enum class OfferPriceProductType
{
    ListPrice,
    NumberPlateFee,
    DeliveryCharge,
    FuelCharge,
    ManufacturerOffer,
    PersonalisedMoneyoffer,
    PersonalisedNonmoneyoffer,
    PersonalisedNonmoneyofferNeg,
    Service,
    ServiceNeg,
    GovernmentGrant,
    OutrightPurchaseDiscount,
    VipOffer,
    WallboxOffer,
    WallboxOfferNeg,
    RoadFundLicence,
    FirstRegistrationFee,
    NotFound,
    AccessoryOffer,
    AccessoryOfferNeg,
    MotabilityDiscount,
}

open class Retailer
{
    open var Id:Int? = null
    open var GssnId:String? = null
    open var Description:String? = null
    open var Street:String? = null
    open var City:String? = null
    open var Postcode:String? = null
    open var GoogleMapPostcode:String? = null
    open var Phone:String? = null
    open var Fax:String? = null
    open var Email:String? = null
    open var Website:String? = null
    open var RetailerGroupId:String? = null
    open var RetailerGroupName:String? = null
    open var IsOnline:Boolean? = null
    open var IsNewCarRetailer:Boolean? = null
    open var IsUsedCarRetailer:Boolean? = null
    open var IsCentralRetailer:Boolean? = null
    open var ChatEnabled:Boolean? = null
    open var TradeInEnabled:Boolean? = null
    open var smart:Boolean? = null
    open var DisplayPhoneNumberNew:String? = null
    open var DisplayPhoneNumberUsed:String? = null
    open var Latitude:BigDecimal? = null
    open var Longitude:BigDecimal? = null
    open var smartDescription:String? = null
    open var smartWebsite:String? = null
    open var smartPhone:String? = null
    open var LegacyId:String? = null
    open var Agent:Boolean? = null
    open var MarketAreaId:Int? = null
    open var DigitalLoungeParentGssnId:String? = null
    open var SendLeadsToDigitalLoungeParent:Boolean? = null
    open var OpeningTimes:RetailerOpeningTimes? = null
}

open class RetailerOpeningTimes
{
    open var New:ArrayList<RetailerOpeningTime> = ArrayList<RetailerOpeningTime>()
    open var Used:ArrayList<RetailerOpeningTime> = ArrayList<RetailerOpeningTime>()
}

open class RetailerOpeningTime
{
    open var Day:String? = null
    open var OpenFrom:String? = null
    open var OpenTo:String? = null
    open var Special:String? = null
}

open class VehicleConsumption
{
    open var Id:Int? = null
    open var Lkm:BigDecimal? = null
    open var Mpg:BigDecimal? = null
}

open class Equipmentv2 : Equipment()
{
    open var Importance:Int? = null
    open var IsAdditional:Boolean? = null
}

open class Equipment
{
    open var Id:Int? = null
    open var Code:String? = null
    open var Description:String? = null
}

open class VehicleEquipmentCategory
{
    open var Order:Int? = null
    open var Code:String? = null
    open var Description:String? = null
    open var Equipment:ArrayList<Equipmentv2>? = null
}

open class VehicleEmissionClass
{
    open var Colour:String? = null
    open var Rating:String? = null
}

open class VehicleAttribute
{
    open var Description:String? = null
    open var Value:String? = null
}

open class VehicleIntegratedServiceCareOption
{
    open var OptionCode:String? = null
    open var BM7NST:String? = null
    open var FullModelYear:String? = null
    open var IntegratedProductType:String? = null
    open var CustomerDescription:String? = null
    open var OneAgentProductType:String? = null
}

open class VehicleError
{
    open var Field:String? = null
    open var Message:String? = null
}

Kotlin GetVehicleRequest 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.

POST /v1/vehicle HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetVehicleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Vehicles">
  <Gssn>String</Gssn>
  <IncludeAllocatedToOrder>false</IncludeAllocatedToOrder>
  <IsOneAdmin>false</IsOneAdmin>
  <Vin>String</Vin>
</GetVehicleRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetVehicleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
  <Errors>
    <VehicleError>
      <Field>String</Field>
      <Message>String</Message>
    </VehicleError>
  </Errors>
  <Vehicle>
    <AccountType>String</AccountType>
    <ActualPrice>0</ActualPrice>
    <Age>0</Age>
    <AvailablePackages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </AvailablePackages>
    <Baumuster>String</Baumuster>
    <Bm7NST>String</Bm7NST>
    <BodyStyle>String</BodyStyle>
    <Brand xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO.Filters.v2">
      <d3p1:BodyStyles>
        <d3p1:BodyStyle>
          <d3p1:Description>String</d3p1:Description>
          <d3p1:Id>0</d3p1:Id>
          <d3p1:Models>
            <d3p1:Model>
              <d3p1:Description>String</d3p1:Description>
              <d3p1:DisplayName>String</d3p1:DisplayName>
              <d3p1:ExcludeFromOnlineShowroomFilters>false</d3p1:ExcludeFromOnlineShowroomFilters>
              <d3p1:Id>0</d3p1:Id>
              <d3p1:ImageUrlLarge>String</d3p1:ImageUrlLarge>
              <d3p1:ImageUrlMedium>String</d3p1:ImageUrlMedium>
              <d3p1:ImageUrlSmall>String</d3p1:ImageUrlSmall>
              <d3p1:Priority>0</d3p1:Priority>
              <d3p1:Specialist>false</d3p1:Specialist>
            </d3p1:Model>
          </d3p1:Models>
        </d3p1:BodyStyle>
      </d3p1:BodyStyles>
      <d3p1:Description>String</d3p1:Description>
      <d3p1:DisplayName>String</d3p1:DisplayName>
      <d3p1:Id>0</d3p1:Id>
    </Brand>
    <BrandId>0</BrandId>
    <ChassisNumber>String</ChassisNumber>
    <Colour>String</Colour>
    <ColourCode>String</ColourCode>
    <ColourDescription>String</ColourDescription>
    <ColourGroup>String</ColourGroup>
    <CommissionNumber>String</CommissionNumber>
    <ConfirmedProductionDate>String</ConfirmedProductionDate>
    <ConsumptionCombined>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </ConsumptionCombined>
    <ConsumptionExtraUrban>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </ConsumptionExtraUrban>
    <ConsumptionUrban>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </ConsumptionUrban>
    <Description>String</Description>
    <DisplayRetailer>String</DisplayRetailer>
    <DisplayRetailerGssnId>String</DisplayRetailerGssnId>
    <DisplayRetailerId>0</DisplayRetailerId>
    <DisplayRetailerMarketAreaId>String</DisplayRetailerMarketAreaId>
    <ElectricConsumption>0</ElectricConsumption>
    <ElectricRange>0</ElectricRange>
    <EligibleForIntegratedServiceCare>false</EligibleForIntegratedServiceCare>
    <Emission>0</Emission>
    <EmissionCombined>0</EmissionCombined>
    <EnergyEfficiencyClass>
      <Colour>String</Colour>
      <Rating>String</Rating>
    </EnergyEfficiencyClass>
    <Engine>
      <Badge>String</Badge>
      <Id>0</Id>
    </Engine>
    <Equipment xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
      <d3p1:Equipmentv2>
        <d3p1:Code>String</d3p1:Code>
        <d3p1:Description>String</d3p1:Description>
        <d3p1:Id>0</d3p1:Id>
        <d3p1:Importance>0</d3p1:Importance>
        <d3p1:IsAdditional>false</d3p1:IsAdditional>
      </d3p1:Equipmentv2>
    </Equipment>
    <EquipmentCategories>
      <VehicleEquipmentCategory>
        <Code>String</Code>
        <Description>String</Description>
        <Equipment xmlns:d5p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
          <d5p1:Equipmentv2>
            <d5p1:Code>String</d5p1:Code>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:Id>0</d5p1:Id>
            <d5p1:Importance>0</d5p1:Importance>
            <d5p1:IsAdditional>false</d5p1:IsAdditional>
          </d5p1:Equipmentv2>
        </Equipment>
        <Order>0</Order>
      </VehicleEquipmentCategory>
    </EquipmentCategories>
    <ForecastedArrivalDate>String</ForecastedArrivalDate>
    <FuelType>String</FuelType>
    <FullModelYearCode>String</FullModelYearCode>
    <HasMildHybridEquipmentCode>false</HasMildHybridEquipmentCode>
    <IntegratedServiceCareOptions>
      <VehicleIntegratedServiceCareOption>
        <BM7NST>String</BM7NST>
        <CustomerDescription>String</CustomerDescription>
        <FullModelYear>String</FullModelYear>
        <IntegratedProductType>String</IntegratedProductType>
        <OneAgentProductType>String</OneAgentProductType>
        <OptionCode>String</OptionCode>
      </VehicleIntegratedServiceCareOption>
    </IntegratedServiceCareOptions>
    <IsAllocatedToBackOrder>false</IsAllocatedToBackOrder>
    <IsAvailableOnline>false</IsAvailableOnline>
    <IsDisplayStock>false</IsDisplayStock>
    <IsExcluded>false</IsExcluded>
    <IsHOBackOrderAccountVehicle>false</IsHOBackOrderAccountVehicle>
    <IsSellable>false</IsSellable>
    <IsSmartDisplayRetailer>false</IsSmartDisplayRetailer>
    <IsSpecialistCar>false</IsSpecialistCar>
    <IspVehicleCustomerDescriptions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </IspVehicleCustomerDescriptions>
    <Line>String</Line>
    <Media>
      <MainImageUrl>String</MainImageUrl>
      <NoImage>false</NoImage>
    </Media>
    <Model>String</Model>
    <ModelId>0</ModelId>
    <NormalisedEmissionDirective>String</NormalisedEmissionDirective>
    <OTR>0</OTR>
    <OnHold>false</OnHold>
    <P11D>0</P11D>
    <Packages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Packages>
    <PortArrivalDate>0001-01-01T00:00:00</PortArrivalDate>
    <Prices>
      <Price>
        <Description>String</Description>
        <Gross>0</Gross>
        <Id>String</Id>
        <Net>0</Net>
        <Product>LIST_PRICE</Product>
        <VAT>0</VAT>
      </Price>
    </Prices>
    <ProductRange>String</ProductRange>
    <ProductionDate>String</ProductionDate>
    <RetailPriceExVat>0</RetailPriceExVat>
    <RetailPrice_ExVAT>0</RetailPrice_ExVAT>
    <RetailPrice_IncVAT>0</RetailPrice_IncVAT>
    <Retailer>
      <Agent>false</Agent>
      <ChatEnabled>false</ChatEnabled>
      <City>String</City>
      <Description>String</Description>
      <DigitalLoungeParentGssnId>String</DigitalLoungeParentGssnId>
      <DisplayPhoneNumberNew>String</DisplayPhoneNumberNew>
      <DisplayPhoneNumberUsed>String</DisplayPhoneNumberUsed>
      <Email>String</Email>
      <Fax>String</Fax>
      <GoogleMapPostcode>String</GoogleMapPostcode>
      <GssnId>String</GssnId>
      <Id>0</Id>
      <IsCentralRetailer>false</IsCentralRetailer>
      <IsNewCarRetailer>false</IsNewCarRetailer>
      <IsOnline>false</IsOnline>
      <IsUsedCarRetailer>false</IsUsedCarRetailer>
      <Latitude>0</Latitude>
      <LegacyId>String</LegacyId>
      <Longitude>0</Longitude>
      <MarketAreaId>0</MarketAreaId>
      <OpeningTimes>
        <New>
          <RetailerOpeningTime>
            <Day>String</Day>
            <OpenFrom>String</OpenFrom>
            <OpenTo>String</OpenTo>
            <Special>String</Special>
          </RetailerOpeningTime>
        </New>
        <Used>
          <RetailerOpeningTime>
            <Day>String</Day>
            <OpenFrom>String</OpenFrom>
            <OpenTo>String</OpenTo>
            <Special>String</Special>
          </RetailerOpeningTime>
        </Used>
      </OpeningTimes>
      <Phone>String</Phone>
      <Postcode>String</Postcode>
      <RetailerGroupId>String</RetailerGroupId>
      <RetailerGroupName>String</RetailerGroupName>
      <SendLeadsToDigitalLoungeParent>false</SendLeadsToDigitalLoungeParent>
      <Street>String</Street>
      <TradeInEnabled>false</TradeInEnabled>
      <Website>String</Website>
      <smart>false</smart>
      <smartDescription>String</smartDescription>
      <smartPhone>String</smartPhone>
      <smartWebsite>String</smartWebsite>
    </Retailer>
    <Secured>false</Secured>
    <TransmissionType>String</TransmissionType>
    <UnderOffer>false</UnderOffer>
    <UpholsteryCode>String</UpholsteryCode>
    <UpholsteryDescription>String</UpholsteryDescription>
    <UpholsteryType>String</UpholsteryType>
    <UsageCode>String</UsageCode>
    <VID>String</VID>
    <VehicleClass>String</VehicleClass>
    <VehicleData>
      <VehicleAttribute>
        <Description>String</Description>
        <Value>String</Value>
      </VehicleAttribute>
    </VehicleData>
    <VehicleType>String</VehicleType>
    <Vin>String</Vin>
    <WltpFuelConsumptionCombined>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </WltpFuelConsumptionCombined>
    <WltpFuelConsumptionExtraHigh>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </WltpFuelConsumptionExtraHigh>
    <WltpFuelConsumptionHigh>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </WltpFuelConsumptionHigh>
    <WltpFuelConsumptionLow>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </WltpFuelConsumptionLow>
    <WltpFuelConsumptionMedium>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </WltpFuelConsumptionMedium>
  </Vehicle>
</GetVehicleResponse>