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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Mercedes.VehicleManagement.API.ServiceModel
Imports Mercedes.VehicleManagement.API.Shared.POCO
Imports Mercedes.OS.Vehicle.Shared.POCO

Namespace Global

    Namespace Mercedes.OS.Vehicle.Shared.POCO

        Public Partial Class Equipment
            Public Overridable Property Id As Integer
            Public Overridable Property Code As String
            Public Overridable Property Description As String
        End Class
    End Namespace

    Namespace Mercedes.VehicleManagement.API.ServiceModel

        Public Partial Class VehicleByCommissionNumberRequest
            Implements IGet
            Public Overridable Property vehicleIdentifier As String
            Public Overridable Property VehicleType As String
        End Class
    End Namespace

    Namespace Mercedes.VehicleManagement.API.Shared.POCO

        Public Partial Class FinanceOffer
            Public Overridable Property CampaignDescription As String
            Public Overridable Property TermsAndConditions As String
            Public Overridable Property Label As String
            Public Overridable Property CampaignId As Integer
            Public Overridable Property DocumentUrl As String
            Public Overridable Property From As String
            Public Overridable Property Id As Integer
            Public Overridable Property [To] As String
            Public Overridable Property Value As String
            Public Overridable Property Vin As String
            Public Overridable Property Enabled As Boolean
            Public Overridable Property Pending As Boolean
            Public Overridable Property OfferType As String
        End Class

        Public Partial Class Message
            Public Overridable Property Id As Integer
            Public Overridable Property Vin As String
            Public Overridable Property CampaignId As Integer
            Public Overridable Property Value As String
            Public Overridable Property CampaignDescription As String
            Public Overridable Property From As String
            Public Overridable Property [To] As String
            Public Overridable Property DocumentUrl As String
        End Class

        Public Partial Class Offer
            Public Overridable Property Id As Integer
            Public Overridable Property OfferType As String
            Public Overridable Property CampaignName As String
            Public Overridable Property From As String
            Public Overridable Property [To] As String
            Public Overridable Property Value As String
            Public Overridable Property Net As Decimal?
            Public Overridable Property OfferVehicle As OfferVehicle
            Public Overridable Property Pending As Boolean
            Public Overridable Property DocumentUrl As String
            Public Overridable Property Personalised As Boolean
            Public Overridable Property IsPersonalisedMonetaryOffer As Boolean
            Public Overridable Property CampaignVIPDiscount As Boolean
            Public Overridable Property OfferValueNet As Decimal?
        End Class

        Public Partial Class OfferHistory
            Public Overridable Property Id As Integer
            Public Overridable Property AuditType As String
            Public Overridable Property OfferType As String
            Public Overridable Property Source As String
            Public Overridable Property From As String
            Public Overridable Property [To] As String
            Public Overridable Property Personalised As Boolean
            Public Overridable Property Value As String
            Public Overridable Property Net As String
            Public Overridable Property VAT As String
            Public Overridable Property Description As String
            Public Overridable Property Vin As String
            Public Overridable Property Gssn As String
            Public Overridable Property Creation As String
            Public Overridable Property Modified As String
            Public Overridable Property UserId As String
            Public Overridable Property User As Integer
            Public Overridable Property OfferId As Integer
            Public Overridable Property CommissionNumber As String
            Public Overridable Property CampaignId As Integer?
            Public Overridable Property CampaignDescription As String
            Public Overridable Property CreationDate As Date
            Public Overridable Property IsUsedCarOffer As Boolean
        End Class

        Public Partial Class OfferVehicle
            Public Overridable Property RetailPriceExVAT As String
        End Class

        Public Partial Class PersonalisedOffer
            Inherits Offer
            Public Overridable Property Category As String
            Public Overridable Property Description As String
            Public Overridable Property Reference As String
        End Class

        Public Partial Class VehicleByCommissionNumberResponse
            Inherits VehicleByIdentifierResponse
            Public Overridable Property Vehicle As VehicleIdentifierData
        End Class

        Public Partial Class VehicleByIdentifierResponse
            Public Overridable Property CampaignOffers As List(Of Offer) = New List(Of Offer)
            Public Overridable Property CampaignPersonalisedOffers As List(Of PersonalisedOffer) = New List(Of PersonalisedOffer)
            Public Overridable Property CampaignOLEVGrantOffers As List(Of Offer) = New List(Of Offer)
            Public Overridable Property CampaignMessages As List(Of Message) = New List(Of Message)
            Public Overridable Property OfferHistories As List(Of OfferHistory)
            Public Overridable Property FinanceOffers As List(Of FinanceOffer)
        End Class

        Public Partial Class VehicleData
            Inherits VehicleDataBase
            Public Overridable Property Engine As String
        End Class

        Public Partial Class VehicleDataBase
            Public Overridable Property Vin As String
            Public Overridable Property Description As String
            Public Overridable Property Model As String
            Public Overridable Property Otr As String
            Public Overridable Property RetailPriceExVAT As String
            Public Overridable Property ActualPrice As String
            Public Overridable Property FuelType As String
            Public Overridable Property Transmission As String
            Public Overridable Property TransmissionType As String
            Public Overridable Property Colour As String
            Public Overridable Property ColourCode As String
            Public Overridable Property ColourDescription As String
            Public Overridable Property CommissionNumber As String
            Public Overridable Property OfferAvailable As Boolean
            Public Overridable Property CampaignDiscountOfferTotal As Integer
            Public Overridable Property CampaignDiscountOfferTotalCurrent As Integer
            Public Overridable Property CampaignDiscountOfferTotalPending As Integer
            Public Overridable Property CampaignServiceOfferTotal As Integer
            Public Overridable Property CampaignServiceOfferTotalCurrent As Integer
            Public Overridable Property CampaignServiceOfferTotalPending As Integer
            Public Overridable Property CampaignCustomOfferTotal As Integer
            Public Overridable Property CampaignPersonalisedOfferTotalCurrent As Integer
            Public Overridable Property CampaignPersonalisedOfferTotalPending As Integer
            Public Overridable Property CampaignPersonalisedOfferTotal As Integer
            Public Overridable Property CampaignCustomOfferTotalCurrent As Integer
            Public Overridable Property CampaignCustomOfferTotalPending As Integer
            Public Overridable Property CampaignOtherOfferTotal As Integer
            Public Overridable Property CampaignOtherOfferTotalCurrent As Integer
            Public Overridable Property CampaignOtherOfferTotalPending As Integer
            Public Overridable Property RetailerDiscountOfferTotal As Integer
            Public Overridable Property RetailerDiscountOfferTotalCurrent As Integer
            Public Overridable Property RetailerDiscountOfferTotalPending As Integer
            Public Overridable Property RetailerServiceOfferTotal As Integer
            Public Overridable Property RetailerServiceOfferTotalCurrent As Integer
            Public Overridable Property RetailerServiceOfferTotalPending As Integer
            Public Overridable Property RetailerCustomOfferTotal As Integer
            Public Overridable Property RetailerCustomOfferTotalCurrent As Integer
            Public Overridable Property RetailerCustomOfferTotalPending As Integer
            Public Overridable Property RetailerWarrantyOfferTotal As Integer
            Public Overridable Property RetailerWarrantyOfferTotalCurrent As Integer
            Public Overridable Property RetailerWarrantyOfferTotalPending As Integer
            Public Overridable Property RetailerOfferTotal As Integer
            Public Overridable Property RetailerOfferTotalCurrent As Integer
            Public Overridable Property RetailerOfferTotalPending As Integer
            Public Overridable Property CampaignOfferTotal As Integer
            Public Overridable Property CampaignOfferTotalCurrent As Integer
            Public Overridable Property CampaignOfferTotalPending As Integer
            Public Overridable Property CampaignAndOfferTotal As Integer
            Public Overridable Property CampaignAndOfferTotalCurrent As Integer
            Public Overridable Property CampaignAndOfferTotalPending As Integer
            Public Overridable Property OfferTotal As Integer
            Public Overridable Property OfferTotalCurrent As Integer
            Public Overridable Property OfferTotalPending As Integer
            Public Overridable Property Creation As String
            Public Overridable Property Modified As String
            Public Overridable Property ElectricRange As Integer
            Public Overridable Property ElectricConsumption As Integer
            Public Overridable Property PortArrivalDate As Date?
            Public Overridable Property DaysSincePortArrival As Integer?
            Public Overridable Property RetailPriceIncVAT As Decimal
            Public Overridable Property BodyStyle As String
            Public Overridable Property Upholstery As String
            Public Overridable Property UpholsteryCode As String
            Public Overridable Property UpholsteryType As String
            Public Overridable Property PackageNames As List(Of String) = New List(Of String)
            Public Overridable Property Line As String
            Public Overridable Property CurrentRetailerOfferPrice As Decimal
            Public Overridable Property RetailPrice As String
            Public Overridable Property VATQualifying As Boolean
            Public Overridable Property RetailerId As Integer
            Public Overridable Property GssnId As String
            Public Overridable Property NoImage As Boolean
            Public Overridable Property ImageUrl As String
            Public Overridable Property IsAvailableOnline As Boolean
            Public Overridable Property IsBackOrdered As Boolean
            Public Overridable Property CreationDate As String
            Public Overridable Property MaintenanceDate As String
            Public Overridable Property RegistrationNumber As String
            Public Overridable Property RegistrationDate As Date?
            Public Overridable Property Mileage As Integer?
            Public Overridable Property TradeInDate As Date?
            Public Overridable Property Source As String
            Public Overridable Property VehicleType As String
            Public Overridable Property OfferAmount As String
            Public Overridable Property OfferExpiry As String
            Public Overridable Property ActiveOffers As Integer() = New Integer(){}
            Public Overridable Property CampaignMessagesTotal As Integer
            Public Overridable Property UnderOffer As Boolean
            Public Overridable Property IsDisplayStock As Boolean
            Public Overridable Property DisplayRetailer As String
            Public Overridable Property DisplayRetailerGssnId As String
            Public Overridable Property Location As String
            Public Overridable Property Account As String
            Public Overridable Property AccountType As String
            Public Overridable Property UsageCode As String
            Public Overridable Property Bm7NST As String
            Public Overridable Property IsSellable As Boolean
            Public Overridable Property Secured As Boolean
            Public Overridable Property Specialist As Boolean
            Public Overridable Property IsMotabilityRetailer As Boolean
            Public Overridable Property UpholsteryDescription As String
            Public Overridable Property InBackOrderAccount As Boolean
            Public Overridable Property FullModelYearCode As String
            Public Overridable Property ProductionDate As Date?
            Public Overridable Property Baumuster As String
            Public Overridable Property IsMotability As Boolean
            Public Overridable Property PipAdvanceRentalGross As Decimal?
            Public Overridable Property WpmsAdvanceRentalGross As Decimal?
            Public Overridable Property IspVehicleCustomerDescriptions As List(Of String)
        End Class

        Public Partial Class VehicleIdentifierData
            Inherits VehicleData
            Public Overridable Property Retailer As String
            Public Overridable Property HasMotabilityError As Boolean
            Public Overridable Property Equipment As List(Of Equipment) = New List(Of Equipment)
        End Class
    End Namespace
End Namespace

VB.NET VehicleByCommissionNumberRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

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

{"vehicle":{"retailer":"String","hasMotabilityError":false,"equipment":[{"id":0,"code":"String","description":"String"}],"engine":"String","vin":"String","description":"String","model":"String","otr":"String","retailPriceExVAT":"String","actualPrice":"String","fuelType":"String","transmission":"String","transmissionType":"String","colour":"String","colourCode":"String","colourDescription":"String","commissionNumber":"String","offerAvailable":false,"campaignDiscountOfferTotal":0,"campaignDiscountOfferTotalCurrent":0,"campaignDiscountOfferTotalPending":0,"campaignServiceOfferTotal":0,"campaignServiceOfferTotalCurrent":0,"campaignServiceOfferTotalPending":0,"campaignCustomOfferTotal":0,"campaignPersonalisedOfferTotalCurrent":0,"campaignPersonalisedOfferTotalPending":0,"campaignPersonalisedOfferTotal":0,"campaignCustomOfferTotalCurrent":0,"campaignCustomOfferTotalPending":0,"campaignOtherOfferTotal":0,"campaignOtherOfferTotalCurrent":0,"campaignOtherOfferTotalPending":0,"retailerDiscountOfferTotal":0,"retailerDiscountOfferTotalCurrent":0,"retailerDiscountOfferTotalPending":0,"retailerServiceOfferTotal":0,"retailerServiceOfferTotalCurrent":0,"retailerServiceOfferTotalPending":0,"retailerCustomOfferTotal":0,"retailerCustomOfferTotalCurrent":0,"retailerCustomOfferTotalPending":0,"retailerWarrantyOfferTotal":0,"retailerWarrantyOfferTotalCurrent":0,"retailerWarrantyOfferTotalPending":0,"retailerOfferTotal":0,"retailerOfferTotalCurrent":0,"retailerOfferTotalPending":0,"campaignOfferTotal":0,"campaignOfferTotalCurrent":0,"campaignOfferTotalPending":0,"campaignAndOfferTotal":0,"campaignAndOfferTotalCurrent":0,"campaignAndOfferTotalPending":0,"offerTotal":0,"offerTotalCurrent":0,"offerTotalPending":0,"creation":"String","modified":"String","electricRange":0,"electricConsumption":0,"portArrivalDate":"\/Date(-62135596800000-0000)\/","daysSincePortArrival":0,"retailPriceIncVAT":0,"bodyStyle":"String","upholstery":"String","upholsteryCode":"String","upholsteryType":"String","packageNames":["String"],"line":"String","currentRetailerOfferPrice":0,"retailPrice":"String","vatQualifying":false,"retailerId":0,"gssnId":"String","noImage":false,"imageUrl":"String","isAvailableOnline":false,"isBackOrdered":false,"creationDate":"String","maintenanceDate":"String","registrationNumber":"String","registrationDate":"\/Date(-62135596800000-0000)\/","mileage":0,"tradeInDate":"\/Date(-62135596800000-0000)\/","source":"String","vehicleType":"String","offerAmount":"String","offerExpiry":"String","activeOffers":[0],"campaignMessagesTotal":0,"underOffer":false,"isDisplayStock":false,"displayRetailer":"String","displayRetailerGssnId":"String","location":"String","account":"String","accountType":"String","usageCode":"String","bm7NST":"String","isSellable":false,"secured":false,"specialist":false,"isMotabilityRetailer":false,"upholsteryDescription":"String","inBackOrderAccount":false,"fullModelYearCode":"String","productionDate":"\/Date(-62135596800000-0000)\/","baumuster":"String","isMotability":false,"pipAdvanceRentalGross":0,"wpmsAdvanceRentalGross":0,"ispVehicleCustomerDescriptions":["String"]},"campaignOffers":[{"id":0,"offerType":"String","campaignName":"String","from":"String","to":"String","value":"String","net":0,"offerVehicle":{"retailPriceExVAT":"String"},"pending":false,"documentUrl":"String","personalised":false,"isPersonalisedMonetaryOffer":false,"campaignVIPDiscount":false,"offerValueNet":0}],"campaignPersonalisedOffers":[{"category":"String","description":"String","reference":"String","id":0,"offerType":"String","campaignName":"String","from":"String","to":"String","value":"String","net":0,"offerVehicle":{"retailPriceExVAT":"String"},"pending":false,"documentUrl":"String","personalised":false,"isPersonalisedMonetaryOffer":false,"campaignVIPDiscount":false,"offerValueNet":0}],"campaignOLEVGrantOffers":[{"id":0,"offerType":"String","campaignName":"String","from":"String","to":"String","value":"String","net":0,"offerVehicle":{"retailPriceExVAT":"String"},"pending":false,"documentUrl":"String","personalised":false,"isPersonalisedMonetaryOffer":false,"campaignVIPDiscount":false,"offerValueNet":0}],"campaignMessages":[{"id":0,"vin":"String","campaignId":0,"value":"String","campaignDescription":"String","from":"String","to":"String","documentUrl":"String"}],"offerHistories":[{"id":0,"auditType":"String","offerType":"String","source":"String","from":"String","to":"String","personalised":false,"value":"String","net":"String","vat":"String","description":"String","vin":"String","gssn":"String","creation":"String","modified":"String","userId":"String","user":0,"offerId":0,"commissionNumber":"String","campaignId":0,"campaignDescription":"String","creationDate":"\/Date(-62135596800000-0000)\/","isUsedCarOffer":false}],"financeOffers":[{"campaignDescription":"String","termsAndConditions":"String","label":"String","campaignId":0,"documentUrl":"String","from":"String","id":0,"to":"String","value":"String","vin":"String","enabled":false,"pending":false,"offerType":"String"}]}