GET | /v1/{VehicleType}/Vehicle/Central | Get central vehicle data |
---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class CentralVehiclesRequest : IGet, IDataShapedRequest
{
open var vehicleType:String? = null
/**
* If specified, the API will shape the data in the response to only include the specified fields
*/
@ApiMember(Description="If specified, the API will shape the data in the response to only include the specified fields", ParameterType="model")
override var fields:String? = null
}
open class VehiclesByRetailerResponse
{
open var vehicles:ArrayList<VehicleIdentifierData> = ArrayList<VehicleIdentifierData>()
}
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 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 class Equipment
{
open var id:Int? = null
open var code:String? = null
open var description:String? = null
}
Kotlin CentralVehiclesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK Content-Type: text/jsonl 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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","mileage":0,"tradeInDate":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","baumuster":"String","isMotability":false,"pipAdvanceRentalGross":0,"wpmsAdvanceRentalGross":0,"ispVehicleCustomerDescriptions":["String"]}]}