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
namespace Mercedes.VehicleManagement.API.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type OfferVehicle() = 
        member val RetailPriceExVAT:String = null with get,set

    [<AllowNullLiteral>]
    type Offer() = 
        member val Id:Int32 = new Int32() with get,set
        member val OfferType:String = null with get,set
        member val CampaignName:String = null with get,set
        member val From:String = null with get,set
        member val To:String = null with get,set
        member val Value:String = null with get,set
        member val Net:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OfferVehicle:OfferVehicle = null with get,set
        member val Pending:Boolean = new Boolean() with get,set
        member val DocumentUrl:String = null with get,set
        member val Personalised:Boolean = new Boolean() with get,set
        member val IsPersonalisedMonetaryOffer:Boolean = new Boolean() with get,set
        member val CampaignVIPDiscount:Boolean = new Boolean() with get,set
        member val OfferValueNet:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type PersonalisedOffer() = 
        inherit Offer()
        member val Category:String = null with get,set
        member val Description:String = null with get,set
        member val Reference:String = null with get,set

    [<AllowNullLiteral>]
    type Message() = 
        member val Id:Int32 = new Int32() with get,set
        member val Vin:String = null with get,set
        member val CampaignId:Int32 = new Int32() with get,set
        member val Value:String = null with get,set
        member val CampaignDescription:String = null with get,set
        member val From:String = null with get,set
        member val To:String = null with get,set
        member val DocumentUrl:String = null with get,set

    [<AllowNullLiteral>]
    type OfferHistory() = 
        member val Id:Int32 = new Int32() with get,set
        member val AuditType:String = null with get,set
        member val OfferType:String = null with get,set
        member val Source:String = null with get,set
        member val From:String = null with get,set
        member val To:String = null with get,set
        member val Personalised:Boolean = new Boolean() with get,set
        member val Value:String = null with get,set
        member val Net:String = null with get,set
        member val VAT:String = null with get,set
        member val Description:String = null with get,set
        member val Vin:String = null with get,set
        member val Gssn:String = null with get,set
        member val Creation:String = null with get,set
        member val Modified:String = null with get,set
        member val UserId:String = null with get,set
        member val User:Int32 = new Int32() with get,set
        member val OfferId:Int32 = new Int32() with get,set
        member val CommissionNumber:String = null with get,set
        member val CampaignId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CampaignDescription:String = null with get,set
        member val CreationDate:DateTime = new DateTime() with get,set
        member val IsUsedCarOffer:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type FinanceOffer() = 
        member val CampaignDescription:String = null with get,set
        member val TermsAndConditions:String = null with get,set
        member val Label:String = null with get,set
        member val CampaignId:Int32 = new Int32() with get,set
        member val DocumentUrl:String = null with get,set
        member val From:String = null with get,set
        member val Id:Int32 = new Int32() with get,set
        member val To:String = null with get,set
        member val Value:String = null with get,set
        member val Vin:String = null with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val Pending:Boolean = new Boolean() with get,set
        member val OfferType:String = null with get,set

    [<AllowNullLiteral>]
    type VehicleByIdentifierResponse() = 
        member val CampaignOffers:ResizeArray<Offer> = null with get,set
        member val CampaignPersonalisedOffers:ResizeArray<PersonalisedOffer> = null with get,set
        member val CampaignOLEVGrantOffers:ResizeArray<Offer> = null with get,set
        member val CampaignMessages:ResizeArray<Message> = null with get,set
        member val OfferHistories:ResizeArray<OfferHistory> = null with get,set
        member val FinanceOffers:ResizeArray<FinanceOffer> = null with get,set

    [<AllowNullLiteral>]
    type VehicleDataBase() = 
        member val Vin:String = null with get,set
        member val Description:String = null with get,set
        member val Model:String = null with get,set
        member val Otr:String = null with get,set
        member val RetailPriceExVAT:String = null with get,set
        member val ActualPrice:String = null with get,set
        member val FuelType:String = null with get,set
        member val Transmission:String = null with get,set
        member val TransmissionType:String = null with get,set
        member val Colour:String = null with get,set
        member val ColourCode:String = null with get,set
        member val ColourDescription:String = null with get,set
        member val CommissionNumber:String = null with get,set
        member val OfferAvailable:Boolean = new Boolean() with get,set
        member val CampaignDiscountOfferTotal:Int32 = new Int32() with get,set
        member val CampaignDiscountOfferTotalCurrent:Int32 = new Int32() with get,set
        member val CampaignDiscountOfferTotalPending:Int32 = new Int32() with get,set
        member val CampaignServiceOfferTotal:Int32 = new Int32() with get,set
        member val CampaignServiceOfferTotalCurrent:Int32 = new Int32() with get,set
        member val CampaignServiceOfferTotalPending:Int32 = new Int32() with get,set
        member val CampaignCustomOfferTotal:Int32 = new Int32() with get,set
        member val CampaignPersonalisedOfferTotalCurrent:Int32 = new Int32() with get,set
        member val CampaignPersonalisedOfferTotalPending:Int32 = new Int32() with get,set
        member val CampaignPersonalisedOfferTotal:Int32 = new Int32() with get,set
        member val CampaignCustomOfferTotalCurrent:Int32 = new Int32() with get,set
        member val CampaignCustomOfferTotalPending:Int32 = new Int32() with get,set
        member val CampaignOtherOfferTotal:Int32 = new Int32() with get,set
        member val CampaignOtherOfferTotalCurrent:Int32 = new Int32() with get,set
        member val CampaignOtherOfferTotalPending:Int32 = new Int32() with get,set
        member val RetailerDiscountOfferTotal:Int32 = new Int32() with get,set
        member val RetailerDiscountOfferTotalCurrent:Int32 = new Int32() with get,set
        member val RetailerDiscountOfferTotalPending:Int32 = new Int32() with get,set
        member val RetailerServiceOfferTotal:Int32 = new Int32() with get,set
        member val RetailerServiceOfferTotalCurrent:Int32 = new Int32() with get,set
        member val RetailerServiceOfferTotalPending:Int32 = new Int32() with get,set
        member val RetailerCustomOfferTotal:Int32 = new Int32() with get,set
        member val RetailerCustomOfferTotalCurrent:Int32 = new Int32() with get,set
        member val RetailerCustomOfferTotalPending:Int32 = new Int32() with get,set
        member val RetailerWarrantyOfferTotal:Int32 = new Int32() with get,set
        member val RetailerWarrantyOfferTotalCurrent:Int32 = new Int32() with get,set
        member val RetailerWarrantyOfferTotalPending:Int32 = new Int32() with get,set
        member val RetailerOfferTotal:Int32 = new Int32() with get,set
        member val RetailerOfferTotalCurrent:Int32 = new Int32() with get,set
        member val RetailerOfferTotalPending:Int32 = new Int32() with get,set
        member val CampaignOfferTotal:Int32 = new Int32() with get,set
        member val CampaignOfferTotalCurrent:Int32 = new Int32() with get,set
        member val CampaignOfferTotalPending:Int32 = new Int32() with get,set
        member val CampaignAndOfferTotal:Int32 = new Int32() with get,set
        member val CampaignAndOfferTotalCurrent:Int32 = new Int32() with get,set
        member val CampaignAndOfferTotalPending:Int32 = new Int32() with get,set
        member val OfferTotal:Int32 = new Int32() with get,set
        member val OfferTotalCurrent:Int32 = new Int32() with get,set
        member val OfferTotalPending:Int32 = new Int32() with get,set
        member val Creation:String = null with get,set
        member val Modified:String = null with get,set
        member val ElectricRange:Int32 = new Int32() with get,set
        member val ElectricConsumption:Int32 = new Int32() with get,set
        member val PortArrivalDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DaysSincePortArrival:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RetailPriceIncVAT:Decimal = new Decimal() with get,set
        member val BodyStyle:String = null with get,set
        member val Upholstery:String = null with get,set
        member val UpholsteryCode:String = null with get,set
        member val UpholsteryType:String = null with get,set
        member val PackageNames:ResizeArray<String> = null with get,set
        member val Line:String = null with get,set
        member val CurrentRetailerOfferPrice:Decimal = new Decimal() with get,set
        member val RetailPrice:String = null with get,set
        member val VATQualifying:Boolean = new Boolean() with get,set
        member val RetailerId:Int32 = new Int32() with get,set
        member val GssnId:String = null with get,set
        member val NoImage:Boolean = new Boolean() with get,set
        member val ImageUrl:String = null with get,set
        member val IsAvailableOnline:Boolean = new Boolean() with get,set
        member val IsBackOrdered:Boolean = new Boolean() with get,set
        member val CreationDate:String = null with get,set
        member val MaintenanceDate:String = null with get,set
        member val RegistrationNumber:String = null with get,set
        member val RegistrationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Mileage:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TradeInDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Source:String = null with get,set
        member val VehicleType:String = null with get,set
        member val OfferAmount:String = null with get,set
        member val OfferExpiry:String = null with get,set
        member val ActiveOffers:Int32[] = null with get,set
        member val CampaignMessagesTotal:Int32 = new Int32() with get,set
        member val UnderOffer:Boolean = new Boolean() with get,set
        member val IsDisplayStock:Boolean = new Boolean() with get,set
        member val DisplayRetailer:String = null with get,set
        member val DisplayRetailerGssnId:String = null with get,set
        member val Location:String = null with get,set
        member val Account:String = null with get,set
        member val AccountType:String = null with get,set
        member val UsageCode:String = null with get,set
        member val Bm7NST:String = null with get,set
        member val IsSellable:Boolean = new Boolean() with get,set
        member val Secured:Boolean = new Boolean() with get,set
        member val Specialist:Boolean = new Boolean() with get,set
        member val IsMotabilityRetailer:Boolean = new Boolean() with get,set
        member val UpholsteryDescription:String = null with get,set
        member val InBackOrderAccount:Boolean = new Boolean() with get,set
        member val FullModelYearCode:String = null with get,set
        member val ProductionDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Baumuster:String = null with get,set
        member val IsMotability:Boolean = new Boolean() with get,set
        member val PipAdvanceRentalGross:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val WpmsAdvanceRentalGross:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val IspVehicleCustomerDescriptions:ResizeArray<String> = null with get,set

    [<AllowNullLiteral>]
    type VehicleData() = 
        inherit VehicleDataBase()
        member val Engine:String = null with get,set

    [<AllowNullLiteral>]
    type Equipment() = 
        member val Id:Int32 = new Int32() with get,set
        member val Code:String = null with get,set
        member val Description:String = null with get,set

    [<AllowNullLiteral>]
    type VehicleIdentifierData() = 
        inherit VehicleData()
        member val Retailer:String = null with get,set
        member val HasMotabilityError:Boolean = new Boolean() with get,set
        member val Equipment:ResizeArray<Equipment> = null with get,set

    [<AllowNullLiteral>]
    type VehicleByCommissionNumberResponse() = 
        inherit VehicleByIdentifierResponse()
        member val Vehicle:VehicleIdentifierData = null with get,set

    [<AllowNullLiteral>]
    type VehicleByCommissionNumberRequest() = 
        interface IGet
        member val vehicleIdentifier:String = null with get,set
        member val VehicleType:String = null with get,set

F# VehicleByCommissionNumberRequest DTOs

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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: 0001-01-01,
		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: 0001-01-01,
		mileage: 0,
		tradeInDate: 0001-01-01,
		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: 0001-01-01,
		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: 0001-01-01,
			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
		}
	]
}