Mercedes.VehicleManagement.API

<back to all web services

MotabilityVehiclesFilterRequest

Vehicle
Requires Authentication
The following routes are available for this service:
POST/v1/{VehicleType}/Vehicle/MotabilityFilter motability 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 P11D: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
        member val EligibleForMaTransfer:Boolean = new Boolean() with get,set
        member val ConfirmedProductionDate:String = null with get,set
        member val ForecastedArrivalDate:String = null with get,set

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

    [<AllowNullLiteral>]
    type Equipment() = 
        member val Id:Nullable<Int32> = new Nullable<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 MotabilityVehiclesFilterRequest() = 
        interface IPost
        member val Min:Int32 = new Int32() with get,set
        member val Max:Int32 = new Int32() with get,set
        member val NoPortArrivalDate:Boolean = new Boolean() with get,set
        member val VehicleType:String = null with get,set

F# MotabilityVehiclesFilterRequest DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/{VehicleType}/Vehicle/Motability HTTP/1.1 
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MotabilityVehiclesFilterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.ServiceModel">
  <Max>0</Max>
  <Min>0</Min>
  <NoPortArrivalDate>false</NoPortArrivalDate>
  <VehicleType>String</VehicleType>
</MotabilityVehiclesFilterRequest>

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

<VehiclesByRetailerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.Shared.POCO">
  <Vehicles>
    <VehicleIdentifierData>
      <Account>String</Account>
      <AccountType>String</AccountType>
      <ActiveOffers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </ActiveOffers>
      <ActualPrice>String</ActualPrice>
      <Baumuster>String</Baumuster>
      <Bm7NST>String</Bm7NST>
      <BodyStyle>String</BodyStyle>
      <CampaignAndOfferTotal>0</CampaignAndOfferTotal>
      <CampaignAndOfferTotalCurrent>0</CampaignAndOfferTotalCurrent>
      <CampaignAndOfferTotalPending>0</CampaignAndOfferTotalPending>
      <CampaignCustomOfferTotal>0</CampaignCustomOfferTotal>
      <CampaignCustomOfferTotalCurrent>0</CampaignCustomOfferTotalCurrent>
      <CampaignCustomOfferTotalPending>0</CampaignCustomOfferTotalPending>
      <CampaignDiscountOfferTotal>0</CampaignDiscountOfferTotal>
      <CampaignDiscountOfferTotalCurrent>0</CampaignDiscountOfferTotalCurrent>
      <CampaignDiscountOfferTotalPending>0</CampaignDiscountOfferTotalPending>
      <CampaignMessagesTotal>0</CampaignMessagesTotal>
      <CampaignOfferTotal>0</CampaignOfferTotal>
      <CampaignOfferTotalCurrent>0</CampaignOfferTotalCurrent>
      <CampaignOfferTotalPending>0</CampaignOfferTotalPending>
      <CampaignOtherOfferTotal>0</CampaignOtherOfferTotal>
      <CampaignOtherOfferTotalCurrent>0</CampaignOtherOfferTotalCurrent>
      <CampaignOtherOfferTotalPending>0</CampaignOtherOfferTotalPending>
      <CampaignPersonalisedOfferTotal>0</CampaignPersonalisedOfferTotal>
      <CampaignPersonalisedOfferTotalCurrent>0</CampaignPersonalisedOfferTotalCurrent>
      <CampaignPersonalisedOfferTotalPending>0</CampaignPersonalisedOfferTotalPending>
      <CampaignServiceOfferTotal>0</CampaignServiceOfferTotal>
      <CampaignServiceOfferTotalCurrent>0</CampaignServiceOfferTotalCurrent>
      <CampaignServiceOfferTotalPending>0</CampaignServiceOfferTotalPending>
      <Colour>String</Colour>
      <ColourCode>String</ColourCode>
      <ColourDescription>String</ColourDescription>
      <CommissionNumber>String</CommissionNumber>
      <ConfirmedProductionDate>String</ConfirmedProductionDate>
      <Creation>String</Creation>
      <CreationDate>String</CreationDate>
      <CurrentRetailerOfferPrice>0</CurrentRetailerOfferPrice>
      <DaysSincePortArrival>0</DaysSincePortArrival>
      <Description>String</Description>
      <DisplayRetailer>String</DisplayRetailer>
      <DisplayRetailerGssnId>String</DisplayRetailerGssnId>
      <ElectricConsumption>0</ElectricConsumption>
      <ElectricRange>0</ElectricRange>
      <EligibleForMaTransfer>false</EligibleForMaTransfer>
      <ForecastedArrivalDate>String</ForecastedArrivalDate>
      <FuelType>String</FuelType>
      <FullModelYearCode>String</FullModelYearCode>
      <GssnId>String</GssnId>
      <ImageUrl>String</ImageUrl>
      <InBackOrderAccount>false</InBackOrderAccount>
      <IsAvailableOnline>false</IsAvailableOnline>
      <IsBackOrdered>false</IsBackOrdered>
      <IsDisplayStock>false</IsDisplayStock>
      <IsMotability>false</IsMotability>
      <IsMotabilityRetailer>false</IsMotabilityRetailer>
      <IsSellable>false</IsSellable>
      <IspVehicleCustomerDescriptions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </IspVehicleCustomerDescriptions>
      <Line>String</Line>
      <Location>String</Location>
      <MaintenanceDate>String</MaintenanceDate>
      <Mileage>0</Mileage>
      <Model>String</Model>
      <Modified>String</Modified>
      <NoImage>false</NoImage>
      <OfferAmount>String</OfferAmount>
      <OfferAvailable>false</OfferAvailable>
      <OfferExpiry>String</OfferExpiry>
      <OfferTotal>0</OfferTotal>
      <OfferTotalCurrent>0</OfferTotalCurrent>
      <OfferTotalPending>0</OfferTotalPending>
      <Otr>String</Otr>
      <P11D>String</P11D>
      <PackageNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </PackageNames>
      <PipAdvanceRentalGross>0</PipAdvanceRentalGross>
      <PortArrivalDate>0001-01-01T00:00:00</PortArrivalDate>
      <ProductionDate>0001-01-01T00:00:00</ProductionDate>
      <RegistrationDate>0001-01-01T00:00:00</RegistrationDate>
      <RegistrationNumber>String</RegistrationNumber>
      <RetailPrice>String</RetailPrice>
      <RetailPriceExVAT>String</RetailPriceExVAT>
      <RetailPriceIncVAT>0</RetailPriceIncVAT>
      <RetailerCustomOfferTotal>0</RetailerCustomOfferTotal>
      <RetailerCustomOfferTotalCurrent>0</RetailerCustomOfferTotalCurrent>
      <RetailerCustomOfferTotalPending>0</RetailerCustomOfferTotalPending>
      <RetailerDiscountOfferTotal>0</RetailerDiscountOfferTotal>
      <RetailerDiscountOfferTotalCurrent>0</RetailerDiscountOfferTotalCurrent>
      <RetailerDiscountOfferTotalPending>0</RetailerDiscountOfferTotalPending>
      <RetailerId>0</RetailerId>
      <RetailerOfferTotal>0</RetailerOfferTotal>
      <RetailerOfferTotalCurrent>0</RetailerOfferTotalCurrent>
      <RetailerOfferTotalPending>0</RetailerOfferTotalPending>
      <RetailerServiceOfferTotal>0</RetailerServiceOfferTotal>
      <RetailerServiceOfferTotalCurrent>0</RetailerServiceOfferTotalCurrent>
      <RetailerServiceOfferTotalPending>0</RetailerServiceOfferTotalPending>
      <RetailerWarrantyOfferTotal>0</RetailerWarrantyOfferTotal>
      <RetailerWarrantyOfferTotalCurrent>0</RetailerWarrantyOfferTotalCurrent>
      <RetailerWarrantyOfferTotalPending>0</RetailerWarrantyOfferTotalPending>
      <Secured>false</Secured>
      <Source>String</Source>
      <Specialist>false</Specialist>
      <TradeInDate>0001-01-01T00:00:00</TradeInDate>
      <Transmission>String</Transmission>
      <TransmissionType>String</TransmissionType>
      <UnderOffer>false</UnderOffer>
      <Upholstery>String</Upholstery>
      <UpholsteryCode>String</UpholsteryCode>
      <UpholsteryDescription>String</UpholsteryDescription>
      <UpholsteryType>String</UpholsteryType>
      <UsageCode>String</UsageCode>
      <VATQualifying>false</VATQualifying>
      <VehicleType>String</VehicleType>
      <Vin>String</Vin>
      <WpmsAdvanceRentalGross>0</WpmsAdvanceRentalGross>
      <Engine>String</Engine>
      <Equipment xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
        <d4p1:Equipment>
          <d4p1:Code>String</d4p1:Code>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:Id>0</d4p1:Id>
        </d4p1:Equipment>
      </Equipment>
      <HasMotabilityError>false</HasMotabilityError>
      <Retailer>String</Retailer>
    </VehicleIdentifierData>
  </Vehicles>
</VehiclesByRetailerResponse>