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 .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,
		p11D: 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
		],
		eligibleForMaTransfer: False,
		confirmedProductionDate: String,
		forecastedArrivalDate: 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,
			campaignGovernmentGrant: False
		}
	],
	campaignPersonalisedOffers: 
	[
		{
			category: String,
			description: String,
			reference: String,
			campaignId: 0,
			certificateRequired: False,
			autoSelect: False,
			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,
			campaignGovernmentGrant: False
		}
	],
	campaignGovernmentGrantOffers: 
	[
		{
			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,
			campaignGovernmentGrant: False
		}
	],
	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
		}
	]
}