forked from Geotab/data-intake-gateway
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdata-intake-gateway-api.yaml
642 lines (640 loc) · 21.2 KB
/
data-intake-gateway-api.yaml
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
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
openapi: 3.0.1
info:
title: Data Intake Gateway
version: v1.0.0
paths:
/Authentication/authenticate:
post:
tags:
- Authentication
summary: "Authenticate to the api"
description: "Authenticate against the api with credentials. Returns an AuthenticationStatus"
operationId: "authenticate"
requestBody:
description: "The username and password to authenticate with"
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticateModel'
responses:
"200":
description: "Authentication successful"
content:
application/json:
schema:
type: object
properties:
Error:
type: array
nullable: true
items:
type: string
Data:
$ref: '#/components/schemas/AuthenticationStatus'
example:
Error: []
Data:
Authenticated: true
UserId: "[email protected]"
BearerToken:
TokenString: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6ImRpZ0BnZW8udGFiIiwibmJmIjoxNjEyODQ2ODAwLCJleHAiOjE2MTMxMDYwMDAsImlhdCI6MTYxMjg0NjgwMH0.janBC23AuH2NzjN42Qt35HC0MuBfl7jaiu9k8jAbrpE"
Created: "2021-02-09T05:00:00.000000Z"
Expires: "2021-02-12T05:00:00.000000Z"
RefreshToken:
TokenString: "S3TjiZ90tdTZ0/ckIHCpE44dLaAgdvx+RpDDz51tCEFMMTitZXc4yQhq==jN"
Created: "2021-02-09T05:00:00.000000Z"
Expires: "2021-02-12T17:00:00.000000Z"
"400":
description: "Request was missing all or part of the required parameters"
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ApiErrorResponse'
- type: object
properties:
Data:
type: object
example:
Error:
- "Error message here"
Data: {}
"401":
description: "Credentials provided could not be used to authenticate successfully"
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ApiErrorResponse'
- type: object
properties:
Data:
type: object
example:
Error:
- "Error message here"
Data: {}
/Authentication/refresh-token:
post:
security:
- bearerAuth: []
tags:
- Authentication
summary: "Refresh authenticated session using refresh and bearer tokens"
description: ""
operationId: "refresh-token"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TokenRefreshModel'
responses:
"200":
description: "Authentication refresh was successful"
content:
application/json:
schema:
type: object
properties:
Error:
type: array
nullable: true
items:
type: string
Data:
$ref: '#/components/schemas/AuthenticationStatus'
example:
Error: []
Data:
Authenticated: true
UserId: "[email protected]"
BearerToken:
TokenString: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6ImRpZ0BnZW8udGFiIiwibmJmIjoxNjEyODQ2ODEwLCJleHAiOjE2MTMxMDYwMTAsImlhdCI6MTYxMjg0NjgxMH0.pXS0ehnRCwZSzGNLSYGlh_oJCnXieFZBu7HBV6y0b5Q"
Created: "2019-07-26T00:00:10"
Expires: "2019-07-26T00:00:10"
RefreshToken:
TokenString: "m=+tunBX6uDBY/Rk9OUQeZdCdmaQgzPHdGvVH2B3cuCXwjADdqvD44vyCr0Z"
Created: "2019-07-26T00:00:10"
Expires: "2019-07-26T00:00:10"
"400":
description: "Request was missing all or part of the required parameters"
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ApiErrorResponse'
- type: object
properties:
Data:
type: object
example:
Error:
- "Error message here"
Data: {}
"401":
description: "Tokens provided could not be used to authenticate successfully"
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ApiErrorResponse'
- type: object
properties:
Data:
type: object
example:
Error:
- "Error message here"
Data: {}
"403":
description: "Insufficient permissions to perform operation"
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ApiErrorResponse'
- type: object
properties:
Data:
type: object
example:
Error:
- "Error message here"
Data: {}
/Authentication/revoke-token:
post:
security:
- bearerAuth: []
tags:
- Authentication
summary: "Revoke current tokens"
description: ""
operationId: "revoke-token"
requestBody:
description: "Revoke the current set of tokens so they are no longer valid"
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TokenRefreshModel'
responses:
"200":
description: "Token revokation was successful"
content:
application/json:
schema:
type: object
properties:
Error:
type: array
nullable: true
items:
type: string
Data:
type: string
example:
Error: []
Data: "Refresh token revoked."
"400":
description: "Request was missing all or part of the required parameters"
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ApiErrorResponse'
- type: object
properties:
Data:
type: object
example:
Error:
- "Error message here"
Data: {}
"401":
description: "Tokens provided could not be used to authenticate successfully"
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ApiErrorResponse'
- type: object
properties:
Data:
type: object
example:
Error:
- "Error message here"
Data: {}
"403":
description: "Insufficient permissions to perform operation"
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ApiErrorResponse'
- type: object
properties:
Data:
type: object
example:
Error:
- "Error message here"
Data: {}
/InvalidRecords:
get:
security:
- bearerAuth: []
tags:
- Invalid Records
parameters:
- name: nextResultKey
in: query
schema:
type: integer
- name: numberOfResults
in: query
schema:
type: integer
minimum: 1
maximum: 50000
default: 1000
responses:
"200":
description: "Fetch batch of invalid records"
content:
application/json:
schema:
type: object
properties:
Error:
type: array
nullable: true
items:
type: string
Data:
$ref: '#/components/schemas/InvalidRecordSet'
example:
Error: []
Data:
NextResultKey: 1002154023
CurrentResultKey: 1002152089
TotalNumberOfInvalidRecords: 16545
CurrentNumberOfInvalidRecords: 200
InvalidRecords:
- BaseRecord:
SerialNo: "2396122106100"
Type: "GenericStatusRecord"
DateTime: "2021-02-10T01:00:00.500Z"
Cause: "Reason message was rejected"
TimeStamp: "2021-02-10T02:00:00Z"
UserId: "[email protected]"
- BaseRecord:
SerialNo: "6605174986852"
Type: "StatusRecord"
DateTime: "2021-02-10T01:00:00.010Z"
Code: 12
Value: 5
Cause: "Reason message was rejected"
TimeStamp: "2021-02-10T02:01:00Z"
UserId: "[email protected]"
"400":
description: "Request was missing all or part of the required parameters"
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ApiErrorResponse'
- type: object
properties:
Data:
type: object
example:
Error:
- "Error message here"
Data: {}
"401":
description: "Tokens provided could not be used to authenticate successfully"
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ApiErrorResponse'
- type: object
properties:
Data:
type: object
example:
Error:
- "Error message here"
Data: {}
/Records:
post:
security:
- bearerAuth: []
tags:
- Records
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/AccelerationRecord'
- $ref: '#/components/schemas/BinaryRecord'
- $ref: '#/components/schemas/DriverChangeRecord'
- $ref: '#/components/schemas/GenericStatusRecord'
- $ref: '#/components/schemas/GpsRecord'
- $ref: '#/components/schemas/StatusRecord'
- $ref: '#/components/schemas/VinRecord'
example:
- SerialNo: "2396122106100"
Type: "VinRecord"
DateTime: "2021-02-10T01:00:00Z"
VehicleIdentificationNumber: "1NZI3SA5WPAJE2YR3"
- SerialNo: "8378832278466"
Type: "StatusRecord"
DateTime: "2021-02-10T01:00:01.500Z"
Code: 12
Value: 5
responses:
"202":
description: "Records accepted for processing"
content:
application/json:
schema:
type: object
properties:
Error:
type: array
nullable: true
items:
type: string
Data:
type: string
format: uuid
example:
Error: []
Data: "feeac962-4496-4458-a489-e2d9b4ea12ec"
"400":
description: "Request was missing all or part of the required parameters"
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/ApiErrorResponse'
- type: object
properties:
Data:
type: object
example:
Error:
- "Error message here"
Data: {}
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
AuthenticationStatus:
type: object
properties:
Authenticated:
type: boolean
UserId:
type: string
BearerToken:
$ref: "#/components/schemas/Token"
RefreshToken:
$ref: "#/components/schemas/Token"
ApiErrorResponse:
type: object
properties:
Error:
type: array
items:
type: string
Data:
type: object
AuthenticateModel:
required:
- password
- username
type: object
properties:
Username:
type: string
Password:
type: string
additionalProperties: false
TokenRefreshModel:
required:
- bearerToken
- refreshToken
type: object
properties:
bearerToken:
type: string
refreshToken:
type: string
additionalProperties: false
Token:
type: object
properties:
TokenString:
type: string
Expires:
type: string
format: date-time
Created:
type: string
format: date-time
AccelerationRecord:
description: A data record class that contains acceleration data.
allOf:
- $ref: '#/components/schemas/BaseRecord'
- type: object
properties:
X:
type: integer
description: The X axis acceleration.
Y:
type: integer
description: The Y axis acceleration.
Z:
type: integer
description: The Z axis acceleration.
BaseRecord:
type: object
description: An abstract data record class (all fields are required).
properties:
Type:
type: string
description: Indicates the type of record.
dateTime:
type: string
format: date-time
description: Date and time of the record in the ISO 8601 RFC3339 format.
serialNo:
type: string
description: Device serial number.
additionalProperties: false
BinaryRecord:
description: A data record class that supports arbitrary binary data.
allOf:
- $ref: '#/components/schemas/BaseRecord'
- type: object
properties:
Data:
type: string
format: byte
description: Arbitrary binary payload, Base64 encoded. Maximum size of 32745 bytes.
DriverChangeRecord:
description: A data record class that contains driver change data.
allOf:
- $ref: '#/components/schemas/BaseRecord'
- type: object
properties:
KeyType:
type: integer
format: byte (8-bit unsigned)
description: The key type.
DriverId:
type: string
format: byte
description: Driver ID, Base64 encoded.
GenericStatusRecord:
description: A data record class that supports generalised data from a telematics device. Supports a specific set of codes.
allOf:
- $ref: '#/components/schemas/StatusRecord'
- type: object
GpsRecord:
description: A data record class that contains latitudinal and longitudinal location data and speed (km/h). Other ancillary flags are also supported.
allOf:
- $ref: '#/components/schemas/BaseRecord'
- type: object
properties:
IsAuxiliary1On:
type: boolean
description: A value indicating whether the auxiliary is on.
IsAuxiliary2On:
type: boolean
description: A value indicating whether the auxiliary is on.
IsAuxiliary3On:
type: boolean
description: A value indicating whether the auxiliary is on.
IsAuxiliary4On:
type: boolean
description: A value indicating whether the auxiliary is on.
IsAuxiliary5On:
type: boolean
description: A value indicating whether the auxiliary is on.
IsAuxiliary6On:
type: boolean
description: A value indicating whether the auxiliary is on.
IsAuxiliary7On:
type: boolean
description: A value indicating whether the auxiliary is on.
IsAuxiliary8On:
type: boolean
description: A value indicating whether the auxiliary is on.
IsGpsValid:
type: boolean
description: A value indicating whether the GPS is valid.
IsIgnitionOn:
type: boolean
description: A value indicating whether the ignition is on.
Latitude:
type: number
format: float
description: The latitude.
Longitude:
type: number
format: float
description: The longitude.
Speed:
type: number
format: float
description: The speed in kilometers per hour.
StatusRecord:
description: A data record class that contains status data.
allOf:
- $ref: '#/components/schemas/BaseRecord'
- type: object
properties:
Code:
type: integer
description: The diagnostic code.
Value:
type: integer
description: The value of the diagnostic.
VinRecord:
description: A data record class that contains vehicle identification data.
allOf:
- $ref: '#/components/schemas/BaseRecord'
- type: object
properties:
VehicleIdentificationNumber:
type: string
description: Vehicle Identification Number.
InvalidRecordSet:
type: object
description: A data record class that contains invalid record data.
properties:
NextResultKey:
type: integer
format: int64
description: Cursor pointing to the next record after the current set.
CurrentResultKey:
type: integer
format: int64
description: Cursor pointing to the start of the current results.
TotalNumberOfInvalidRecords:
type: integer
format: int64
description: Total number of invalid records for the current user.
CurrentNumberOfInvalidRecords:
type: integer
format: int64
description: Number of invalid records in the current set.
InvalidRecords:
type: array
items:
$ref: '#/components/schemas/InvalidRecord'
description: Array of InvalidRecords.
additionalProperties: false
InvalidRecord:
type: object
description: A data record class that contains data which is not accepted by the API.
properties:
BaseRecord:
$ref: '#/components/schemas/BaseRecord'
Cause:
type: string
nullable: true
description: Reason the record was rejected.
TimeStamp:
type: string
format: date-time
description: Date and time the record was marked invalid in the ISO 8601 RFC3339 format.
UserId:
type: string
nullable: true
description: ID of the user who owns this record.
additionalProperties: false