Mercedes.VehicleManagement.API

<back to all web services

AllAvailableVehiclesByCriteriaRequest

Vehicle
Requires Authentication
The following routes are available for this service:
POST/v1/AllAvailableVehicles/{vehicleType}/{includeBackOrderAccounts}Get all available vehicles
namespace Mercedes.VehicleManagement.API.Shared.POCO.V3

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

    [<AllowNullLiteral>]
    type BasicBackOrderVehicle() = 
        member val CommissionNumber:String = null with get,set
        member val Description:String = null with get,set
        member val Model:String = null with get,set
        member val Colour:String = null with get,set
        member val FuelType:String = null with get,set
        member val Transmission:String = null with get,set
        member val Packages:String = null with get,set
        member val Lines:String = null with get,set
        member val Upholstery:String = null with get,set
        member val EmissionCombined:String = null with get,set
        member val ActualPrice:Decimal = new Decimal() with get,set
        member val UsageCode:String = null with get,set
        member val Secured:Boolean = new Boolean() with get,set
        member val Account:String = null with get,set
        member val SecuredTime:String = null with get,set
        member val SecuredReason:String = null with get,set
        member val SecuredByGasId:String = null with get,set
        member val SecuredDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type BackOrderVehicle() = 
        inherit BasicBackOrderVehicle()
        member val Id:Int32 = new Int32() with get,set
        member val Vin:String = null with get,set
        member val VehicleType:String = null with get,set
        member val Vid:String = null with get,set
        member val Fin:String = null with get,set
        member val ChassisNumber:String = null with get,set
        member val ModelYear:String = null with get,set
        member val ModelYearCode:String = null with get,set
        member val HalfModelYearCode:String = null with get,set
        member val FullModelYearCode:String = null with get,set
        member val SalesDescriptionLong:String = null with get,set
        member val VehicleClass:String = null with get,set
        member val RetailPrice_ExVAT:Decimal = new Decimal() with get,set
        member val RetailPrice_IncVAT:Decimal = new Decimal() with get,set
        member val OTR:Decimal = new Decimal() with get,set
        member val BodyStyle:String = null with get,set
        member val ProductRange:String = null with get,set
        member val Engine:String = null with get,set
        member val IsAMG:Boolean = new Boolean() with get,set
        member val ColourGroup:String = null with get,set
        member val UpholsteryCode:String = null with get,set
        member val NST:String = null with get,set
        member val Bm7NST:String = null with get,set
        member val Acceleration:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val BootCapacity:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TopSpeed:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val DriveConcept:String = null with get,set
        member val CombustionPowerHp:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ElectricPowerKw:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ElectricPowerHp:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val CombinedPowerKw:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val CombinedPowerHP:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ElectricRange:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ElectricConsumption:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Emission:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val EmissionDirective:String = null with get,set
        member val EmissionExtraUrban:String = null with get,set
        member val EmissionUrban:String = null with get,set
        member val EnergyEfficiencyClass:String = null with get,set
        member val WLTPEmissionCombined:String = null with get,set
        member val WLTPCombined:String = null with get,set
        member val WLTPLow:String = null with get,set
        member val WLTPMedium:String = null with get,set
        member val WLTPHigh:String = null with get,set
        member val WLTPExtraHigh:String = null with get,set
        member val ProductionDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PortArrivalDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CreationDate:DateTime = new DateTime() with get,set
        member val LastUpdated:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IsDisplayStock:Boolean = new Boolean() with get,set
        member val DisplayStockAgent:String = null with get,set
        member val IsSpecialistCar:Boolean = new Boolean() with get,set
        member val Location:String = null with get,set
        member val CesarIdShipToParty:String = null with get,set
        member val IsSellable:Boolean = new Boolean() with get,set
        member val UnderOffer:Boolean = new Boolean() with get,set
        member val Baumuster:String = null with get,set

    [<AllowNullLiteral>]
    type StockManagementResponse() = 
        member val TotalVehicles:Int32 = new Int32() with get,set
        member val Vehicles:IEnumerable<BackOrderVehicle> = null with get,set

    [<AllowNullLiteral>]
    type BaseAllAvailableVehiclesRequest() = 
        member val VehicleType:String = null with get,set
        member val IncludeBackOrderAccounts:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CampaignExclusion() = 
        member val Vin:String[] = null with get,set
        member val CommissionNumber:String[] = null with get,set
        member val ModelYearCode:String = null with get,set
        member val EquipmentCode:String = null with get,set
        member val Gssn:String[] = null with get,set

    [<AllowNullLiteral>]
    type RegistrationDate() = 
        member val From:DateTime = new DateTime() with get,set
        member val To:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type Age() = 
        member val Date:DateTime = new DateTime() with get,set
        member val Min:Int32 = new Int32() with get,set
        member val Max:Int32 = new Int32() with get,set
        member val IncludePipelineStock:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type PortArrivalDate() = 
        member val PipelineStock:Boolean = new Boolean() with get,set
        member val From:DateTime = new DateTime() with get,set
        member val To:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type VehicleSearchV3Criteria() = 
        member val Vin:String[] = null with get,set
        member val Model:Int32[] = null with get,set
        member val Fuel:Int32[] = null with get,set
        member val Transmission:Int32[] = null with get,set
        member val Engine:Int32[] = null with get,set
        member val Line:String[] = null with get,set
        member val MappedLine:Int32[] = null with get,set
        member val CommissionNumber:String[] = null with get,set
        member val VehicleType:String = null with get,set
        member val Exclusion:CampaignExclusion = null with get,set
        member val RegNo:String = null with get,set
        member val IncludeOffline:Boolean = new Boolean() with get,set
        member val RegistrationDate:RegistrationDate = null with get,set
        member val Age:Age = null with get,set
        member val PortArrivalDate:PortArrivalDate = null with get,set
        member val IsAvailableOnline:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val IsBackOrdered:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val IsSellable:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val IsUnderOffer:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val MBUKSecured:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Account:String[] = null with get,set
        member val Baumuster:String[] = null with get,set
        member val Colours:Int32[] = null with get,set
        member val Upholstery:Int32[] = null with get,set
        member val Package:Int32[] = null with get,set
        member val NST:String[] = null with get,set
        member val UsageCode:String[] = null with get,set

    [<AllowNullLiteral>]
    type AllAvailableVehiclesByCriteriaRequest() = 
        inherit BaseAllAvailableVehiclesRequest()
        interface IPost
        member val Criteria:VehicleSearchV3Criteria = null with get,set

F# AllAvailableVehiclesByCriteriaRequest 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.

POST /v1/AllAvailableVehicles/{vehicleType}/{includeBackOrderAccounts} HTTP/1.1 
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	criteria: 
	{
		vin: 
		[
			String
		],
		model: 
		[
			0
		],
		fuel: 
		[
			0
		],
		transmission: 
		[
			0
		],
		engine: 
		[
			0
		],
		line: 
		[
			String
		],
		mappedLine: 
		[
			0
		],
		commissionNumber: 
		[
			String
		],
		vehicleType: String,
		exclusion: 
		{
			vin: 
			[
				String
			],
			commissionNumber: 
			[
				String
			],
			modelYearCode: String,
			equipmentCode: String,
			gssn: 
			[
				String
			]
		},
		regNo: String,
		includeOffline: False,
		registrationDate: 
		{
			from: 0001-01-01,
			to: 0001-01-01
		},
		age: 
		{
			date: 0001-01-01,
			min: 0,
			max: 0,
			includePipelineStock: False
		},
		portArrivalDate: 
		{
			pipelineStock: False,
			from: 0001-01-01,
			to: 0001-01-01
		},
		isAvailableOnline: False,
		isBackOrdered: False,
		isSellable: False,
		isUnderOffer: False,
		mbukSecured: False,
		account: 
		[
			String
		],
		baumuster: 
		[
			String
		],
		colours: 
		[
			0
		],
		upholstery: 
		[
			0
		],
		package: 
		[
			0
		],
		nst: 
		[
			String
		],
		usageCode: 
		[
			String
		]
	},
	vehicleType: String,
	includeBackOrderAccounts: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	"totalVehicles": 0,
	"vehicles": null
}