Mercedes.VehicleManagement.API

<back to all web services

CentralVehiclesRequest

Vehicle
Requires Authentication
The following routes are available for this service:
GET/v1/{VehicleType}/Vehicle/CentralGet central vehicle data
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 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 VehiclesByRetailerResponse() = 
        member val Vehicles:ResizeArray<VehicleIdentifierData> = null with get,set

    [<AllowNullLiteral>]
    type CentralVehiclesRequest() = 
        interface IGet
        member val VehicleType:String = null with get,set
        ///<summary>
        ///If specified, the API will shape the data in the response to only include the specified fields
        ///</summary>
        [<ApiMember(Description="If specified, the API will shape the data in the response to only include the specified fields", ParameterType="model")>]
        member val Fields:String = null with get,set

F# CentralVehiclesRequest 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/Central 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

{
	vehicles: 
	[
		{
			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
			]
		}
	]
}