Mercedes.VehicleManagement.API

<back to all web services

VehicleByCommissionNumberRequest

Vehicle
Requires Authentication
The following routes are available for this service:
GET/v1/{VehicleType}/Vehicle/{vehicleIdentifier}Get vehicle data by commission number
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class VehicleByCommissionNumberRequest : IGet
{
    open var vehicleIdentifier:String? = null
    open var vehicleType:String? = null
}

open class VehicleByCommissionNumberResponse : VehicleByIdentifierResponse()
{
    open var vehicle:VehicleIdentifierData? = null
}

open class VehicleByIdentifierResponse
{
    open var campaignOffers:ArrayList<Offer> = ArrayList<Offer>()
    open var campaignPersonalisedOffers:ArrayList<PersonalisedOffer> = ArrayList<PersonalisedOffer>()
    open var campaignGovernmentGrantOffers:ArrayList<Offer> = ArrayList<Offer>()
    open var campaignMessages:ArrayList<Message> = ArrayList<Message>()
    open var offerHistories:ArrayList<OfferHistory>? = null
    open var financeOffers:ArrayList<FinanceOffer>? = null
}

open class Offer
{
    open var id:Int? = null
    open var offerType:String? = null
    open var campaignName:String? = null
    open var from:String? = null
    open var to:String? = null
    open var value:String? = null
    open var net:BigDecimal? = null
    open var offerVehicle:OfferVehicle? = null
    open var pending:Boolean? = null
    open var documentUrl:String? = null
    open var personalised:Boolean? = null
    open var isPersonalisedMonetaryOffer:Boolean? = null
    open var campaignVIPDiscount:Boolean? = null
    open var offerValueNet:BigDecimal? = null
    open var campaignGovernmentGrant:Boolean? = null
}

open class OfferVehicle
{
    open var retailPriceExVAT:String? = null
}

open class PersonalisedOffer : Offer()
{
    open var category:String? = null
    open var description:String? = null
    open var reference:String? = null
    open var campaignId:Int? = null
    open var certificateRequired:Boolean? = null
    open var autoSelect:Boolean? = null
}

open class Message
{
    open var id:Int? = null
    open var vin:String? = null
    open var campaignId:Int? = null
    open var value:String? = null
    open var campaignDescription:String? = null
    open var from:String? = null
    open var to:String? = null
    open var documentUrl:String? = null
}

open class OfferHistory
{
    open var id:Int? = null
    open var auditType:String? = null
    open var offerType:String? = null
    open var source:String? = null
    open var from:String? = null
    open var to:String? = null
    open var personalised:Boolean? = null
    open var value:String? = null
    open var net:String? = null
    open var vat:String? = null
    open var description:String? = null
    open var vin:String? = null
    open var gssn:String? = null
    open var creation:String? = null
    open var modified:String? = null
    open var userId:String? = null
    open var user:Int? = null
    open var offerId:Int? = null
    open var commissionNumber:String? = null
    open var campaignId:Int? = null
    open var campaignDescription:String? = null
    open var creationDate:Date? = null
    open var isUsedCarOffer:Boolean? = null
}

open class FinanceOffer
{
    open var campaignDescription:String? = null
    open var termsAndConditions:String? = null
    open var label:String? = null
    open var campaignId:Int? = null
    open var documentUrl:String? = null
    open var from:String? = null
    open var id:Int? = null
    open var to:String? = null
    open var value:String? = null
    open var vin:String? = null
    open var enabled:Boolean? = null
    open var pending:Boolean? = null
    open var offerType:String? = null
}

open class VehicleIdentifierData : VehicleData()
{
    open var retailer:String? = null
    open var hasMotabilityError:Boolean? = null
    open var equipment:ArrayList<Equipment> = ArrayList<Equipment>()
}

open class VehicleData : VehicleDataBase()
{
    open var engine:String? = null
}

open class VehicleDataBase
{
    open var vin:String? = null
    open var description:String? = null
    open var model:String? = null
    open var otr:String? = null
    open var retailPriceExVAT:String? = null
    open var actualPrice:String? = null
    open var p11D:String? = null
    open var fuelType:String? = null
    open var transmission:String? = null
    open var transmissionType:String? = null
    open var colour:String? = null
    open var colourCode:String? = null
    open var colourDescription:String? = null
    open var commissionNumber:String? = null
    open var offerAvailable:Boolean? = null
    open var campaignDiscountOfferTotal:Int? = null
    open var campaignDiscountOfferTotalCurrent:Int? = null
    open var campaignDiscountOfferTotalPending:Int? = null
    open var campaignServiceOfferTotal:Int? = null
    open var campaignServiceOfferTotalCurrent:Int? = null
    open var campaignServiceOfferTotalPending:Int? = null
    open var campaignCustomOfferTotal:Int? = null
    open var campaignPersonalisedOfferTotalCurrent:Int? = null
    open var campaignPersonalisedOfferTotalPending:Int? = null
    open var campaignPersonalisedOfferTotal:Int? = null
    open var campaignCustomOfferTotalCurrent:Int? = null
    open var campaignCustomOfferTotalPending:Int? = null
    open var campaignOtherOfferTotal:Int? = null
    open var campaignOtherOfferTotalCurrent:Int? = null
    open var campaignOtherOfferTotalPending:Int? = null
    open var retailerDiscountOfferTotal:Int? = null
    open var retailerDiscountOfferTotalCurrent:Int? = null
    open var retailerDiscountOfferTotalPending:Int? = null
    open var retailerServiceOfferTotal:Int? = null
    open var retailerServiceOfferTotalCurrent:Int? = null
    open var retailerServiceOfferTotalPending:Int? = null
    open var retailerCustomOfferTotal:Int? = null
    open var retailerCustomOfferTotalCurrent:Int? = null
    open var retailerCustomOfferTotalPending:Int? = null
    open var retailerWarrantyOfferTotal:Int? = null
    open var retailerWarrantyOfferTotalCurrent:Int? = null
    open var retailerWarrantyOfferTotalPending:Int? = null
    open var retailerOfferTotal:Int? = null
    open var retailerOfferTotalCurrent:Int? = null
    open var retailerOfferTotalPending:Int? = null
    open var campaignOfferTotal:Int? = null
    open var campaignOfferTotalCurrent:Int? = null
    open var campaignOfferTotalPending:Int? = null
    open var campaignAndOfferTotal:Int? = null
    open var campaignAndOfferTotalCurrent:Int? = null
    open var campaignAndOfferTotalPending:Int? = null
    open var offerTotal:Int? = null
    open var offerTotalCurrent:Int? = null
    open var offerTotalPending:Int? = null
    open var creation:String? = null
    open var modified:String? = null
    open var electricRange:Int? = null
    open var electricConsumption:Int? = null
    open var portArrivalDate:Date? = null
    open var daysSincePortArrival:Int? = null
    open var retailPriceIncVAT:BigDecimal? = null
    open var bodyStyle:String? = null
    open var upholstery:String? = null
    open var upholsteryCode:String? = null
    open var upholsteryType:String? = null
    open var packageNames:ArrayList<String> = ArrayList<String>()
    open var line:String? = null
    open var currentRetailerOfferPrice:BigDecimal? = null
    open var retailPrice:String? = null
    open var vatQualifying:Boolean? = null
    open var retailerId:Int? = null
    open var gssnId:String? = null
    open var noImage:Boolean? = null
    open var imageUrl:String? = null
    open var isAvailableOnline:Boolean? = null
    open var isBackOrdered:Boolean? = null
    open var creationDate:String? = null
    open var maintenanceDate:String? = null
    open var registrationNumber:String? = null
    open var registrationDate:Date? = null
    open var mileage:Int? = null
    open var tradeInDate:Date? = null
    open var source:String? = null
    open var vehicleType:String? = null
    open var offerAmount:String? = null
    open var offerExpiry:String? = null
    open var activeOffers:ArrayList<Int> = ArrayList<Int>()
    open var campaignMessagesTotal:Int? = null
    open var underOffer:Boolean? = null
    open var isDisplayStock:Boolean? = null
    open var displayRetailer:String? = null
    open var displayRetailerGssnId:String? = null
    open var location:String? = null
    open var account:String? = null
    open var accountType:String? = null
    open var usageCode:String? = null
    open var bm7NST:String? = null
    open var isSellable:Boolean? = null
    open var secured:Boolean? = null
    open var specialist:Boolean? = null
    open var isMotabilityRetailer:Boolean? = null
    open var upholsteryDescription:String? = null
    open var inBackOrderAccount:Boolean? = null
    open var fullModelYearCode:String? = null
    open var productionDate:Date? = null
    open var baumuster:String? = null
    open var isMotability:Boolean? = null
    open var pipAdvanceRentalGross:BigDecimal? = null
    open var wpmsAdvanceRentalGross:BigDecimal? = null
    open var ispVehicleCustomerDescriptions:ArrayList<String>? = null
    open var eligibleForMaTransfer:Boolean? = null
    open var confirmedProductionDate:String? = null
    open var forecastedArrivalDate:String? = null
}

open class Equipment
{
    open var id:Int? = null
    open var code:String? = null
    open var description:String? = null
}

Kotlin VehicleByCommissionNumberRequest 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/{vehicleIdentifier} 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

<VehicleByCommissionNumberResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.Shared.POCO">
  <CampaignGovernmentGrantOffers>
    <Offer>
      <CampaignGovernmentGrant>false</CampaignGovernmentGrant>
      <CampaignName>String</CampaignName>
      <CampaignVIPDiscount>false</CampaignVIPDiscount>
      <DocumentUrl>String</DocumentUrl>
      <From>String</From>
      <Id>0</Id>
      <IsPersonalisedMonetaryOffer>false</IsPersonalisedMonetaryOffer>
      <Net>0</Net>
      <OfferType>String</OfferType>
      <OfferValueNet>0</OfferValueNet>
      <OfferVehicle>
        <RetailPriceExVAT>String</RetailPriceExVAT>
      </OfferVehicle>
      <Pending>false</Pending>
      <Personalised>false</Personalised>
      <To>String</To>
      <Value>String</Value>
    </Offer>
  </CampaignGovernmentGrantOffers>
  <CampaignMessages>
    <Message>
      <CampaignDescription>String</CampaignDescription>
      <CampaignId>0</CampaignId>
      <DocumentUrl>String</DocumentUrl>
      <From>String</From>
      <Id>0</Id>
      <To>String</To>
      <Value>String</Value>
      <Vin>String</Vin>
    </Message>
  </CampaignMessages>
  <CampaignOffers>
    <Offer>
      <CampaignGovernmentGrant>false</CampaignGovernmentGrant>
      <CampaignName>String</CampaignName>
      <CampaignVIPDiscount>false</CampaignVIPDiscount>
      <DocumentUrl>String</DocumentUrl>
      <From>String</From>
      <Id>0</Id>
      <IsPersonalisedMonetaryOffer>false</IsPersonalisedMonetaryOffer>
      <Net>0</Net>
      <OfferType>String</OfferType>
      <OfferValueNet>0</OfferValueNet>
      <OfferVehicle>
        <RetailPriceExVAT>String</RetailPriceExVAT>
      </OfferVehicle>
      <Pending>false</Pending>
      <Personalised>false</Personalised>
      <To>String</To>
      <Value>String</Value>
    </Offer>
  </CampaignOffers>
  <CampaignPersonalisedOffers>
    <PersonalisedOffer>
      <CampaignGovernmentGrant>false</CampaignGovernmentGrant>
      <CampaignName>String</CampaignName>
      <CampaignVIPDiscount>false</CampaignVIPDiscount>
      <DocumentUrl>String</DocumentUrl>
      <From>String</From>
      <Id>0</Id>
      <IsPersonalisedMonetaryOffer>false</IsPersonalisedMonetaryOffer>
      <Net>0</Net>
      <OfferType>String</OfferType>
      <OfferValueNet>0</OfferValueNet>
      <OfferVehicle>
        <RetailPriceExVAT>String</RetailPriceExVAT>
      </OfferVehicle>
      <Pending>false</Pending>
      <Personalised>false</Personalised>
      <To>String</To>
      <Value>String</Value>
      <AutoSelect>false</AutoSelect>
      <CampaignId>0</CampaignId>
      <Category>String</Category>
      <CertificateRequired>false</CertificateRequired>
      <Description>String</Description>
      <Reference>String</Reference>
    </PersonalisedOffer>
  </CampaignPersonalisedOffers>
  <FinanceOffers>
    <FinanceOffer>
      <CampaignDescription>String</CampaignDescription>
      <CampaignId>0</CampaignId>
      <DocumentUrl>String</DocumentUrl>
      <Enabled>false</Enabled>
      <From>String</From>
      <Id>0</Id>
      <Label>String</Label>
      <OfferType>String</OfferType>
      <Pending>false</Pending>
      <TermsAndConditions>String</TermsAndConditions>
      <To>String</To>
      <Value>String</Value>
      <Vin>String</Vin>
    </FinanceOffer>
  </FinanceOffers>
  <OfferHistories>
    <OfferHistory>
      <AuditType>String</AuditType>
      <CampaignDescription>String</CampaignDescription>
      <CampaignId>0</CampaignId>
      <CommissionNumber>String</CommissionNumber>
      <Creation>String</Creation>
      <CreationDate>0001-01-01T00:00:00</CreationDate>
      <Description>String</Description>
      <From>String</From>
      <Gssn>String</Gssn>
      <Id>0</Id>
      <IsUsedCarOffer>false</IsUsedCarOffer>
      <Modified>String</Modified>
      <Net>String</Net>
      <OfferId>0</OfferId>
      <OfferType>String</OfferType>
      <Personalised>false</Personalised>
      <Source>String</Source>
      <To>String</To>
      <User>0</User>
      <UserId>String</UserId>
      <VAT>String</VAT>
      <Value>String</Value>
      <Vin>String</Vin>
    </OfferHistory>
  </OfferHistories>
  <Vehicle>
    <Account>String</Account>
    <AccountType>String</AccountType>
    <ActiveOffers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1: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>
    <ConfirmedProductionDate>String</ConfirmedProductionDate>
    <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>
    <EligibleForMaTransfer>false</EligibleForMaTransfer>
    <ForecastedArrivalDate>String</ForecastedArrivalDate>
    <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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1: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>
    <P11D>String</P11D>
    <PackageNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1: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:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
      <d3p1:Equipment>
        <d3p1:Code>String</d3p1:Code>
        <d3p1:Description>String</d3p1:Description>
        <d3p1:Id>0</d3p1:Id>
      </d3p1:Equipment>
    </Equipment>
    <HasMotabilityError>false</HasMotabilityError>
    <Retailer>String</Retailer>
  </Vehicle>
</VehicleByCommissionNumberResponse>