| GET | /v1/details/{vehicleType}/{Identifier} | Get Vehicle Details | |
|---|---|---|---|
| GET | /details/{vehicleType}/{Identifier} | Get Vehicle Details |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Identifier | path | string | Yes | |
| VehicleType | path | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Vehicle | form | BackOrderVehicleDetails | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Engine | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Vin | form | string | Yes | |
| CommissionNumber | form | string | Yes | |
| Description | form | string | Yes | |
| Model | form | string | Yes | |
| FullModelYearCode | form | string | Yes | |
| RetailerId | form | int | No | |
| ImageUrl | form | string | Yes | |
| Colour | form | string | Yes | |
| ColourDescription | form | string | Yes | |
| BodyStyle | form | string | Yes | |
| FuelType | form | string | Yes | |
| Transmission | form | string | Yes | |
| TransmissionType | form | string | Yes | |
| Package | form | string | Yes | |
| Packages | form | List<string> | Yes | |
| Line | form | string | Yes | |
| MappedLine | form | string | Yes | |
| Upholstery | form | string | Yes | |
| UpholsteryDescription | form | string | Yes | |
| UsageCode | form | string | Yes | |
| Account | form | string | Yes | |
| NST | form | string | Yes | |
| Baumuster | form | string | Yes | |
| ElectricRange | form | decimal? | No | |
| ElectricConsumption | form | decimal? | No | |
| RetailPrice_ExVAT | form | decimal | No | |
| ActualPrice | form | decimal? | No | |
| OTRPrice | form | decimal | No | |
| P11D | form | decimal | No | |
| VehicleType | form | string | Yes | |
| Secured | form | bool | No | |
| ProductionDate | form | string | Yes | |
| PortArrivalDate | form | DateTime? | No | |
| DisplayRetailer | form | string | Yes | |
| Location | form | string | Yes | |
| Bm7NST | form | string | Yes | |
| IsAvailableOnline | form | bool | No | |
| IsSpecialistCar | form | bool | No | |
| IsSellable | form | bool | No | |
| InBackOrderAccount | form | bool | No | |
| VehicleAuditDetails | form | List<VehicleAuditDetails> | Yes | |
| IspVehicleCustomerDescriptions | form | List<string> | No | |
| UnderOffer | form | bool | No | |
| IsAllocatedToBackOrder | form | bool | No | |
| EligibleForMaTransfer | form | bool | No | |
| ConfirmedProductionDate | form | string | No | |
| ForecastedArrivalDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserId | form | string | Yes | |
| Status | form | bool | No | |
| Notes | form | string | Yes | |
| CreationDate | form | string | Yes |
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/details/{vehicleType}/{Identifier} 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
{
vehicle:
{
engine: String,
vin: String,
commissionNumber: String,
description: String,
model: String,
fullModelYearCode: String,
retailerId: 0,
imageUrl: String,
colour: String,
colourDescription: String,
bodyStyle: String,
fuelType: String,
transmission: String,
transmissionType: String,
package: String,
packages:
[
String
],
line: String,
mappedLine: String,
upholstery: String,
upholsteryDescription: String,
usageCode: String,
account: String,
nst: String,
baumuster: String,
electricRange: 0,
electricConsumption: 0,
retailPrice_ExVAT: 0,
actualPrice: 0,
otrPrice: 0,
p11D: 0,
vehicleType: String,
secured: False,
productionDate: String,
portArrivalDate: 0001-01-01,
displayRetailer: String,
location: String,
bm7NST: String,
isAvailableOnline: False,
isSpecialistCar: False,
isSellable: False,
inBackOrderAccount: False,
vehicleAuditDetails:
[
{
userId: String,
status: False,
notes: String,
creationDate: String
}
],
ispVehicleCustomerDescriptions:
[
String
],
underOffer: False,
isAllocatedToBackOrder: False,
eligibleForMaTransfer: False,
confirmedProductionDate: String,
forecastedArrivalDate: String
}
}