GET | /v1/{VehicleType}/Vehicle/Central | Get central vehicle data |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
VehicleType | path | string | Yes | |
Fields | model | string | Yes | If specified, the API will shape the data in the response to only include the specified fields |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Vehicles | form | List<VehicleIdentifierData> | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Retailer | form | string | Yes | |
HasMotabilityError | form | bool | No | |
Equipment | form | List<Equipment> | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Engine | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Vin | form | string | Yes | |
Description | form | string | Yes | |
Model | form | string | Yes | |
Otr | form | string | Yes | |
RetailPriceExVAT | form | string | Yes | |
ActualPrice | form | string | Yes | |
FuelType | form | string | Yes | |
Transmission | form | string | Yes | |
TransmissionType | form | string | Yes | |
Colour | form | string | Yes | |
ColourCode | form | string | Yes | |
ColourDescription | form | string | Yes | |
CommissionNumber | form | string | Yes | |
OfferAvailable | form | bool | No | |
CampaignDiscountOfferTotal | form | int | No | |
CampaignDiscountOfferTotalCurrent | form | int | No | |
CampaignDiscountOfferTotalPending | form | int | No | |
CampaignServiceOfferTotal | form | int | No | |
CampaignServiceOfferTotalCurrent | form | int | No | |
CampaignServiceOfferTotalPending | form | int | No | |
CampaignCustomOfferTotal | form | int | No | |
CampaignPersonalisedOfferTotalCurrent | form | int | No | |
CampaignPersonalisedOfferTotalPending | form | int | No | |
CampaignPersonalisedOfferTotal | form | int | No | |
CampaignCustomOfferTotalCurrent | form | int | No | |
CampaignCustomOfferTotalPending | form | int | No | |
CampaignOtherOfferTotal | form | int | No | |
CampaignOtherOfferTotalCurrent | form | int | No | |
CampaignOtherOfferTotalPending | form | int | No | |
RetailerDiscountOfferTotal | form | int | No | |
RetailerDiscountOfferTotalCurrent | form | int | No | |
RetailerDiscountOfferTotalPending | form | int | No | |
RetailerServiceOfferTotal | form | int | No | |
RetailerServiceOfferTotalCurrent | form | int | No | |
RetailerServiceOfferTotalPending | form | int | No | |
RetailerCustomOfferTotal | form | int | No | |
RetailerCustomOfferTotalCurrent | form | int | No | |
RetailerCustomOfferTotalPending | form | int | No | |
RetailerWarrantyOfferTotal | form | int | No | |
RetailerWarrantyOfferTotalCurrent | form | int | No | |
RetailerWarrantyOfferTotalPending | form | int | No | |
RetailerOfferTotal | form | int | No | |
RetailerOfferTotalCurrent | form | int | No | |
RetailerOfferTotalPending | form | int | No | |
CampaignOfferTotal | form | int | No | |
CampaignOfferTotalCurrent | form | int | No | |
CampaignOfferTotalPending | form | int | No | |
CampaignAndOfferTotal | form | int | No | |
CampaignAndOfferTotalCurrent | form | int | No | |
CampaignAndOfferTotalPending | form | int | No | |
OfferTotal | form | int | No | |
OfferTotalCurrent | form | int | No | |
OfferTotalPending | form | int | No | |
Creation | form | string | Yes | |
Modified | form | string | Yes | |
ElectricRange | form | int | No | |
ElectricConsumption | form | int | No | |
PortArrivalDate | form | DateTime? | No | |
DaysSincePortArrival | form | int? | No | |
RetailPriceIncVAT | form | decimal | No | |
BodyStyle | form | string | Yes | |
Upholstery | form | string | Yes | |
UpholsteryCode | form | string | Yes | |
UpholsteryType | form | string | Yes | |
PackageNames | form | List<string> | Yes | |
Line | form | string | Yes | |
CurrentRetailerOfferPrice | form | decimal | No | |
RetailPrice | form | string | Yes | |
VATQualifying | form | bool | No | |
RetailerId | form | int | No | |
GssnId | form | string | Yes | |
NoImage | form | bool | No | |
ImageUrl | form | string | Yes | |
IsAvailableOnline | form | bool | No | |
IsBackOrdered | form | bool | No | |
CreationDate | form | string | Yes | |
MaintenanceDate | form | string | Yes | |
RegistrationNumber | form | string | Yes | |
RegistrationDate | form | DateTime? | No | |
Mileage | form | int? | No | |
TradeInDate | form | DateTime? | No | |
Source | form | string | Yes | |
VehicleType | form | string | Yes | |
OfferAmount | form | string | Yes | |
OfferExpiry | form | string | Yes | |
ActiveOffers | form | int[] | Yes | |
CampaignMessagesTotal | form | int | No | |
UnderOffer | form | bool | No | |
IsDisplayStock | form | bool | No | |
DisplayRetailer | form | string | Yes | |
DisplayRetailerGssnId | form | string | Yes | |
Location | form | string | Yes | |
Account | form | string | Yes | |
AccountType | form | string | Yes | |
UsageCode | form | string | Yes | |
Bm7NST | form | string | Yes | |
IsSellable | form | bool | No | |
Secured | form | bool | No | |
Specialist | form | bool | No | |
IsMotabilityRetailer | form | bool | No | |
UpholsteryDescription | form | string | Yes | |
InBackOrderAccount | form | bool | No | |
FullModelYearCode | form | string | No | |
ProductionDate | form | DateTime? | No | |
Baumuster | form | string | Yes | |
IsMotability | form | bool | No | |
PipAdvanceRentalGross | form | decimal? | No | |
WpmsAdvanceRentalGross | form | decimal? | No | |
IspVehicleCustomerDescriptions | form | List<string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Code | form | string | No | |
Description | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 ] } ] }