-
Notifications
You must be signed in to change notification settings - Fork 0
/
hm-vehicle-static-data-api-v1.yml
535 lines (521 loc) · 19.5 KB
/
hm-vehicle-static-data-api-v1.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
info:
description: |-
This endpoint allows you to retrieve static vehicle data through a RESTful interface.
Authentication:
* For fleet flow use [OAuth2](https://docs.high-mobility.com/guides/platform/oauth2-client-credentials/) using `client_credentials` grant type to obtain access token.
Servers:
* Production server: `https://api.high-mobility.com`
title: Static Data API
version: 1.0.0
contact:
email: support@high-mobility.com
openapi: 3.0.3
paths:
/v1/vehicle-static-data/{vin}:
get:
summary: Vehicle Static Data
parameters:
- description: Vehicle Identification number
in: path
name: vin
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VehicleStaticDataResponse'
examples:
successful:
value:
manufacturer:
brand: "Jeep"
sub_model: "80th Anniversary Plug-In Hybrid 4WD"
type_group_name: "Compass"
model: "Compass (M7)(2020->)"
sales_description: "Compass 1.3 Plug-In Hybrid (EURO 6d) 80th Annivers"
vehicle_main_type_key: "111"
vehicle_sub_type_key: "30"
vehicle_type_key: "1"
equipment:
series_equipment:
- description: "airbag driver side/passenger side"
positions: []
manufacturer_id: null
- descripion: "navigation package"
positions:
- description: "driver assistance system: traffic sign detection (TSR)"
manufacturer_id: "JPE"
special_equipment:
- description: "Winter package"
positions:
- description: "windshield wiper heated"
manufacturer_id: AAC
description: successful operation
'504':
description: Service unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/VehicleStaticDataResponseError'
examples:
When Dat API fails:
value:
errors:
- detail: Error while querying external services. Please try again later
title: Service unavailable
request_id: 89c6b29a-caca-449d-9a60-e2ca21a60fe3
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/VehicleStaticDataResponseError'
examples:
Invalid authorization header:
value:
errors:
- detail: Missing or invalid authorization header
title: Not Authorized
request_id: 89c6b29a-caca-449d-9a60-e2ca21a60fe3
ExpiredToken:
value:
errors:
- detail: Expired token
title: Not Authorized
request_id: 32c6b29a-caca-449d-9a60-e2ca21a60fe3
Invalid JWT Payload:
value:
errors:
- detail: Invalid JWT Payload
title: Not Authorized
request_id: 32c6b29a-caca-449d-9a60-e2ca21a60fe3
description: Not Authorized
security:
- VehicleStaticDataAuth:
- vehicle:static-data
tags:
- Static Data API
/v1/vehicle-static-data/{vin}/valuation:
post:
summary: Vehicle Valuation Data
parameters:
- description: Vehicle Identification number
in: path
name: vin
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VehicleStaticValuationDataRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VehicleStaticValuationDataResponse'
description: successful operation
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/VehicleStaticDataResponse422'
examples:
Missing Params:
value:
errors:
- detail: can't be blank
source: odometer
- detail: has invalid format
source: registration_date
request_id: 89c6b29a-caca-449d-9a60-e2ca21a60fe3
description: Unprocessable Content
'504':
content:
application/json:
schema:
$ref: '#/components/schemas/VehicleStaticDataResponseError'
examples:
When Dat API fails:
value:
errors:
- detail: Error while querying external services. Please try again later
title: Service unavailable
request_id: 89c6b29a-caca-449d-9a60-e2ca21a60fe3
description: Service unavailable
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/VehicleStaticDataResponseError'
examples:
Invalid authorization header:
value:
errors:
- detail: Missing or invalid authorization header
title: Not Authorized
request_id: 89c6b29a-caca-449d-9a60-e2ca21a60fe3
ExpiredToken:
value:
errors:
- detail: Expired token
title: Not Authorized
request_id: 32c6b29a-caca-449d-9a60-e2ca21a60fe3
Invalid JWT Payload:
value:
errors:
- detail: Invalid JWT Payload
title: Not Authorized
request_id: 32c6b29a-caca-449d-9a60-e2ca21a60fe3
description: Not Authorized
security:
- VehicleStaticDataAuth:
- vehicle:static-data
tags:
- Static Data API
servers:
- url: https://sandbox.api.high-mobility.com
- url: https://api.high-mobility.com
components:
schemas:
VehicleStaticDataValuationPricePurchase:
properties:
net:
type: string
format: decimal
description: "Dat key: PurchasePrice | Dealer purchase price, net (incl. equipment)."
example: "15571.43"
gross:
type: string
format: decimal
description: "Dat key: PurchasePriceGross | Dealer purchase price, gross (incl. equipment)."
example: "15571.43"
VehicleStaticDataValuationPriceOriginal:
properties:
net:
type: string
format: decimal
description: "Dat key: OriginalPrice | List original price according to DAT + Market index without optional equipment"
example: "26324"
gross:
type: string
format: decimal
description: "Dat key: OriginalPriceGross | List original price according to DAT + Market index without optional equipment"
example: "31325"
VehicleStaticDataValuationPriceSales:
properties:
net:
type: string
format: decimal
description: "Dat key: SalesPrice | Dealer sales price, net (including equipment)"
example: "17576.10"
gross:
type: string
format: decimal
description: "Dat key: SalesPriceGross | Dealer sales price, gross (including equipment)"
example: "17956.99"
VehicleStaticDataValuationPriceEquipment:
properties:
original:
type: string
format: decimal
description: "Dat key: EquipmentOriginalPrice | List original price of equipment"
example: "0"
value:
type: string
format: decimal
description: "Dat key:EquipmentPrice | Valuated price of equipment"
example: "0"
value_type:
type: string
description: "Dat Key: EquipmentSign"
example: "calculated value"
VehicleStaticDataValuationMargin:
properties:
net:
type: string
format: decimal
description: "Dat key: Margin |Trade margin net"
example: "2004.67"
gross:
type: string
format: decimal
description: "Dat key: MarginGross | Trade margin gross"
example: "2385.56"
VehicleStaticDataValuationPriceInitialRegistrationCorrection:
type: string
format: decimal
description: "Dat key: InitialRegistrationCorr | First-registration adjustment (net)"
example: "617.39"
VehicleStaticDataValuationPriceTires:
properties:
default:
type: string
format: decimal
description: "Dat key: DefaultTiresPrice | Considered value of the standard tires (50%)"
example: "254.00"
VehicleStaticDataValuationPriceBase:
properties:
"1":
type: string
format: decimal
description: "Dat Key: BasePrice | Reference value according to DAT +Market index (net based on regular taxation) without optional equipment"
example: "12786.00"
"2":
type: string
format: decimal
description: "Dat Key: BasePrice2 | Reference value according to DAT adjusted by mileage and first-registration adjustment; base value determined by DAT, net based on regular taxation"
example: "15089.91"
"3":
type: string
format: decimal
description: "Dat Key: BasePrice3 | Base value as determined by DAT, net, based on regular taxation (incl. equipment)"
example: "15089.91"
VehicleStaticDataValuationRegistration:
properties:
obsolete:
type: boolean
description: "Dat Key: Obsolete | Registration. true: obsolete, false: up to date"
example: true
VehicleStaticDataValuationCondition:
properties:
correction_factor_percentage:
type: string
format: number
description: "Dat key: Condition/ConditionCorrectionFactorPerc | User value of condition adjustment in percent of the dealer selling price. Values range from 70 to 130."
example: "100"
correction_amount:
type: object
properties:
net:
type: string
format: decimal
example: "0.00"
description: "Dat key: Condition/ConditionCorrectionAmount | Adjustment sum determined on the basis of parameter ConditionCorrectionFactorPerc as net value"
gross:
type: string
format: decimal
example: "0.00"
description: "Dat key: Condition/ConditionCorrectionAmountGross | Adjustment sum determined on the basis of parameter ConditionCorrectionFactorPerc as gross value"
number_of_owners:
type: string
format: number
example: "1"
description: "Dat key: Condition/NumberOfOwnersN | Number of owners"
sub_total:
type: object
properties:
"1":
type: object
properties:
net:
type: string
format: decimal
example: "15089.91"
description: "Dat key: Condition/ConditionSubTotal1 | Subtotal 1, including: IncreaseInValue, DecreaseInValue, TiresMountedValue, TiresUnmountedValue as net value"
gross:
type: string
format: decimal
example: "17956.99"
description: "Dat key: Condition/ConditionSubTotal1Gross | Subtotal 1, including: IncreaseInValue, DecreaseInValue, TiresMountedValue, TiresUnmountedValue as gross value"
"2":
type: object
properties:
net:
type: string
format: decimal
example: "15089.91"
description: "Dat key: Condition/ConditionSubTotal2 | Subtotal 2, including: OwnerCorrectionAmount, ConditionCorrectionAmount, RepairCosts as net value"
gross:
type: string
format: decimal
example: "17956.99"
description: "Dat key: Condition/ConditionSubTotal2Gross | Subtotal 2, including: OwnerCorrectionAmount, ConditionCorrectionAmount, RepairCosts as gross value"
VehicleStaticDataValuationOdometer:
properties:
reference:
type: string
format: number
example: "103000"
description: "Dat key: ReferenceMileage | Reference driving route according to DAT (km)"
correction:
type: string
format: decimal
example: "1686.52"
description: "Dat key: MileageCorr | Mileage adjustment (net)"
unit:
type: string
example: "kilometers"
description: "Dat key: SignMilageUnit | Unit of mileage"
VehicleStaticDataValuationMeta:
properties:
last_valuation_date:
type: string
format: datetime
description: "Dat key: LastValuationDate | Date of this valuation"
example: "2024-05-02T11:17:02.838+02:00"
residual_value_model:
type: string
description: "Dat key: ResidualValueModel | Residual-value model"
example: dat
type:
type: string
description: "Dat key: ValuationType | Evaluation type"
example: valuation
VehicleStaticDataValuationPrice:
properties:
base:
$ref: '#/components/schemas/VehicleStaticDataValuationPriceBase'
purchase:
$ref: '#/components/schemas/VehicleStaticDataValuationPricePurchase'
orginal:
$ref: "#/components/schemas/VehicleStaticDataValuationPriceOriginal"
sales:
$ref: "#/components/schemas/VehicleStaticDataValuationPriceSales"
equipment:
$ref: "#/components/schemas/VehicleStaticDataValuationPriceEquipment"
tires:
$ref: "#/components/schemas/VehicleStaticDataValuationPriceTires"
margin:
$ref: "#/components/schemas/VehicleStaticDataValuationMargin"
initial_registration_correction:
$ref: "#/components/schemas/VehicleStaticDataValuationPriceInitialRegistrationCorrection"
VehicleStaticDataValuation:
properties:
price:
$ref: '#/components/schemas/VehicleStaticDataValuationPrice'
registration:
$ref: "#/components/schemas/VehicleStaticDataValuationRegistration"
condition:
$ref: "#/components/schemas/VehicleStaticDataValuationCondition"
odometer:
$ref: "#/components/schemas/VehicleStaticDataValuationOdometer"
meta:
$ref: "#/components/schemas/VehicleStaticDataValuationMeta"
VehicleStaticDataManufacturer:
properties:
brand:
type: string
example: Jeep
description: "Dat key: ManufacturerName"
sub_model:
type: string
example: "80th Anniversary Plug-In Hybrid 4WD"
description: "Dat key: SubModelName"
type_group_name:
type: string
example: "Compass"
description: "Dat key: MainTypeGroupName"
model:
type: string
example: "Compass (M7)(2020->)"
description: "Dat key: "
sales_description:
type: string
example: "Compass 1.3 Plug-In Hybrid (EURO 6d) 80th Annivers"
description: "Dat key: SalesDescription"
vehicle_main_type_key:
type: string
example: "111"
description: "Dat key: VINResult/VINECodes/VINECode/VehicleMainTypeKey"
vehicle_sub_type_key:
type: string
example: "30"
description: "Dat key: VINResult/VINECodes/VINECode/VehicleSubTypeKey"
vehicle_type_key:
type: string
example: "1"
description: "Dat key: VINResult/VINECodes/VINECode/VehicleTypeKey"
VehicleStaticDataEquipment:
properties:
series_equipment:
type: array
items:
$ref: '#/components/schemas/VehicleStaticDataEquipmentList'
description: "Dat key: Equipment/SeriesEquipment"
special_equipment:
type: array
items:
$ref: '#/components/schemas/VehicleStaticDataEquipmentList'
description: "Dat key: Equipment/SpecialEquipment"
VehicleStaticDataEquipmentList:
properties:
manufacturer_id:
type: string
example: "JPE"
description: "Dat key: SeriesEquipment/EquipmentPosition/ManufacturerEquipmentId"
description:
type: string
example: "airbag driver side/passenger side"
description: "Dat key: SeriesEquipment/EquipmentPosition/Description"
positions:
type: array
items:
type: string
example:
- description: "driver assistance system: traffic sign detection (TSR)"
description: "Dat key: EquipmentPosition/ContainedEquipmentPositions values"
VehicleStaticDataResponse:
properties:
manufacturer:
$ref: '#/components/schemas/VehicleStaticDataManufacturer'
equipment:
$ref: '#/components/schemas/VehicleStaticDataEquipment'
VehicleStaticValuationDataRequest:
properties:
odometer:
type: number
example: 1222.01
registration_date:
type: string
example: 2004-01-01
VehicleStaticValuationDataResponse:
properties:
valuation:
$ref: '#/components/schemas/VehicleStaticDataValuation'
vehicle:
$ref: '#/components/schemas/VehicleStaticDataResponse'
VehicleStaticDataResponse422:
properties:
errors:
items:
properties:
detail:
type: string
source:
type: string
description:
type: string
type: object
type: array
request_id:
description: The request tracking id. Provide request_id when facing issue
type: string
VehicleStaticDataResponseError:
properties:
errors:
items:
properties:
detail:
example: Failure when fetching data from OEM
type: string
title:
example: Service Unavailable
type: string
type: object
type: array
request_id:
description: The request tracking id. Provide request_id when facing issue
type: string
securitySchemes:
VehicleStaticDataAuth:
flows:
clientCredentials:
scopes:
vehicle:static-data: static vehicle data
tokenUrl: https://api.sandbox.high-mobility.com/v1/access_token
type: oauth2