-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmerged.yaml
1276 lines (1276 loc) · 37.1 KB
/
merged.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
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Equipment Management API
description: This API has all the operations for equipment resource.
version: '2.0'
servers:
- url: https://equipmentapi.deere.com/isg
tags:
- name: Equipment Resource
description: |
This resource provides the ability to retrieve equipment information
based on the supplied query parameters.
paths:
/equipment:
get:
tags:
- Equipment Resource
description: |
- Retrieve all Equipment by either of the following query parameters -
1. Primary filters:
- OrganizationEquipment id(s)
- Organization id(s)
- SerialNumber(s) and/or OrganizationId(s)
- Principal id(s) and/or OrganizationId(s)
2. Supported secondary filters
- categories
- capableOf
- organizationRole.type
- archived
3. Other parameter(s)
- embed
- If none of the primary parameters/filters are supplied in the request
- Should return all the equipment from the organizations that user has access to.
- Should return 403, when user does has access to any organization.
parameters:
- $ref: '#/components/parameters/OrganizationEquipmentIds'
- $ref: '#/components/parameters/EquipmentSerialNumbers'
- $ref: '#/components/parameters/OrganizationIds'
- $ref: '#/components/parameters/PrincipalIds'
- $ref: '#/components/parameters/CapableOf'
- $ref: '#/components/parameters/Categories'
- $ref: '#/components/parameters/Role'
- $ref: '#/components/parameters/Archived'
- $ref: '#/components/parameters/EmbedForList'
- $ref: '#/components/parameters/PageOffset'
- $ref: '#/components/parameters/ItemLimit'
responses:
'200':
description: Equipment(s) found based on the query parameters and filters.
content:
application/json:
schema:
properties:
values:
type: array
items:
anyOf:
- $ref: '#/components/schemas/implement'
- $ref: '#/components/schemas/machine'
'400':
description: Bad Request - No query parameters provided.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: |
Authorization Error
- user/applications does not have access to api or resource
or
- user does not have required permissions/BusinessActivities for the org.
head:
tags:
- Equipment Resource
description: |
- Retrieve count of Equipment by either of the following query parameters -
1. Primary filters:
- Organization id(s)
2. Supported secondary filters
- categories
- capableOf
- organizationRole.type
- archived
- If none of the primary parameters/filters are supplied in the request
- Should return all the equipment from the organizations that user has access to.
- Should return 403, when user does has access to any organization.
- Permissions: EQUIPMENT_1
- BusinessActivity: VIEW_EQUIPMENT_LIST_API
parameters:
- $ref: '#/components/parameters/OrganizationIds'
- $ref: '#/components/parameters/CapableOf'
- $ref: '#/components/parameters/Categories'
- $ref: '#/components/parameters/Role'
- $ref: '#/components/parameters/Archived'
responses:
'200':
description: Equipment(s) found based on the query parameters and filters.
headers:
X-Deere-Count:
schema:
type: integer
format: int32
description: Total count of devices based on the query parameters.
'400':
description: Bad Request - No query parameters provided.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: |
Authorization Error
- user/applications does not have access to api or resource
or
- user does not have required permissions/BusinessActivities for the org.
/organizations/{organizationId}/equipment:
post:
tags:
- Equipment Resource
description: |
- Create Equipment in requested organization.
operationId: createEquipment
parameters:
- $ref: '#/components/parameters/organizationId'
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/machine'
- $ref: '#/components/schemas/implement'
required: true
responses:
'201':
description: Created
'202':
description: Accepted
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: User is not authorized for this request.
/equipment/{id}:
get:
tags:
- Equipment Resource
description: |
- Get Equipment by OrganizationEquipment ID.
parameters:
- $ref: '#/components/parameters/id'
- $ref: '#/components/parameters/Embed'
responses:
'200':
description: Equipment found by Id or Serial Number
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/machine'
- $ref: '#/components/schemas/implement'
'403':
description: |
Authorization Error
- user/applications does not have access to api or resource
or
- user does not have required permissions/BusinessActivities for the org.
'404':
description: Equipment not found
put:
tags:
- Equipment Resource
description: |
- Update Equipment by OrganizationEquipment Id.
operationId: putEquipment
parameters:
- $ref: '#/components/parameters/id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/equipment-patch'
responses:
'200':
description: Patch Successful
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: User is not authorized for this request.
patch:
tags:
- Equipment Resource
description: |
- Patch by OrganizationEquipment Id will allow the following
1. Transfer Equipment to new organization, where paired devices can also be requested for transfer along with the equipment.
- Permissions: EQUIPMENT_3
- BusinessActivity: TRANSFER_ADMIN_RIGHTS
2. Update archived state of equipment, also allows to update the archived state of paired devices.
- Permissions: EQUIPMENT_2
4. Update Name of the Equipment
- Permissions: EQUIPMENT_2
- BusinessActivity: EDIT_EQUIPMENT_LIST
operationId: patchEquipment
parameters:
- $ref: '#/components/parameters/id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/equipment-patch'
responses:
'200':
description: Patch Successful
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: User is not authorized for this request.
delete:
tags:
- Equipment Resource
description: |
- Delete OrganizationEquipment by OrganizationEquipment Id.
operationId: deleteEquipment
parameters:
- $ref: '#/components/parameters/id'
responses:
'200':
description: Deleted
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: User is not authorized for this request.
/equipmentMakes:
get:
tags:
- Equipment Make Resource
description: |
- Retrieves Equipment Makes with embed
operationId: getEquipmentMakes
parameters:
- $ref: '#/components/parameters/deprecated'
- $ref: '#/components/parameters/Embed'
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
links:
type: array
items:
$ref: '#/components/schemas/link'
values:
type: array
items:
$ref: '#/components/schemas/equipment-make'
'403':
description: User is not authorized
/equipmentMakes/{equipmentMakeId}:
get:
tags:
- Equipment Make Resource
description: |
- Retrieve Equipment Make by Id with embed
operationId: getEquipmentMakesById
parameters:
- $ref: '#/components/parameters/EquipmentMakeId'
- $ref: '#/components/parameters/Embed'
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
links:
type: array
items:
$ref: '#/components/schemas/link'
values:
type: array
items:
$ref: '#/components/schemas/equipment-make'
'403':
description: User is not authorized
'404':
description: Resource Not foundapi-makes
/equipmentMakes/{equipmentMakeId}/equipmentTypes:
get:
tags:
- Equipment Type Resource
description: |
- This operation retrieves a list of Equipment Types by makeId supplied query parameters.
operationId: getEquipmentTypesByMakeId
parameters:
- $ref: '#/components/parameters/EquipmentMakeId'
- $ref: '#/components/parameters/deprecated'
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
links:
type: array
items:
$ref: '#/components/schemas/link'
values:
type: array
items:
$ref: '#/components/schemas/equipment-type'
/equipmentMakes/{equipmentMakeId}/equipmentTypes/{equipmentTypeId}:
get:
tags:
- Equipment Type Resource
description: |
- Retrieve Equipment Type by Make Id and Type Id.
operationId: getEquipmentType
parameters:
- $ref: '#/components/parameters/EquipmentMakeId'
- $ref: '#/components/parameters/EquipmentTypeId'
- $ref: '#/components/parameters/Embed'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/equipment-type'
'404':
description: Resource Not Found.
/equipmentTypes:
get:
tags:
- Equipment Type Resource
description: |
- Retrieve all Equipment Types with embed.
operationId: getEquipmentTypes
parameters:
- $ref: '#/components/parameters/EquipmentTypeName'
- $ref: '#/components/parameters/EquipmentMakeName'
- $ref: '#/components/parameters/deprecated'
- $ref: '#/components/parameters/Embed'
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
links:
type: array
items:
$ref: '#/components/schemas/link'
values:
type: array
items:
$ref: '#/components/schemas/equipment-type'
/equipmentMakes/{equipmentMakeId}/equipmentTypes/{equipmentTypeId}/equipmentModels:
parameters:
- $ref: '#/components/parameters/EquipmentMakeId'
- $ref: '#/components/parameters/EquipmentTypeId'
get:
tags:
- Equipment Model Resource
description: |
- This operation retrieves a list of Equipment Models based on makeId and typeId.
operationId: getEquipmentModelsByMakeIdAndTypeId
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
links:
type: array
items:
$ref: '#/components/schemas/link'
values:
type: array
items:
$ref: '#/components/schemas/equipment-model'
'403':
description: User is not authorized
/equipmentMakes/{equipmentMakeId}/equipmentTypes/{equipmentTypeId}/equipmentModels/{equipmentModelId}:
parameters:
- $ref: '#/components/parameters/EquipmentMakeId'
- $ref: '#/components/parameters/EquipmentTypeId'
- $ref: '#/components/parameters/EquipmentModelId'
get:
tags:
- Equipment Model Resource
description: |
- This operation retrieves a single Equipment Model based on given makeId, typeId and modelId.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/equipment-model'
'403':
description: User is not authorized
/equipmentModels:
get:
tags:
- Equipment Model Resource
description: |
- This operation retrieves a list of Equipment Models based on the supplied query parameters.
operationId: getEquipmentModels
parameters:
- $ref: '#/components/parameters/category'
- $ref: '#/components/parameters/deprecated'
- $ref: '#/components/parameters/Embed'
- $ref: '#/components/parameters/PageOffset'
- $ref: '#/components/parameters/ItemLimit'
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
links:
type: array
items:
$ref: '#/components/schemas/link'
values:
type: array
items:
$ref: '#/components/schemas/equipment-model'
components:
schemas:
Error:
type: object
properties:
message:
type: string
description: An english description of the error
example: <parameter> was invalid because <reason>
code:
type: string
description: A string constant representing the type of error
example: 400
field:
type: string
description: The name of the property or parameter deemed invalid
example: Machine.serialNumber
gud:
type: string
format: uuid
description: A reference to this encounter of the error, for traceability and troubleshooting
example: 9b331708-10e8-4e15-8097-a9aed7455d6d
invalidValue:
type: string
description: The value that was supplied for this field in the request
example: null
readOnly: true
Errors:
type: array
items:
$ref: '#/components/schemas/Error'
readOnly: true
link:
openapi: 3.0.0
info:
title: Schema for HATEOAS Link between Axiom resources
contact:
name: Jim Pace
email: PaceJamesR@JohnDeere.com
components:
schemas:
Link:
description: Link to another resource
type: object
required:
- rel
- uri
properties:
rel:
type: string
example: self
uri:
type: string
example: https://apidev.tal.deere.com/platform/users/grumpybear
resource:
required:
- '@type'
type: object
title: Resource
properties:
links:
type: array
items:
$ref: '#/components/schemas/link'
id:
type: string
description: Unique id
example: 363997 | fcdc83cb-8840-4215-84b5-1769889db932
'@type':
type: string
description: Equipment | Machine | Implement | EquipmentType | EquipmentMake | EquipmentModel | Organization | TheftRecord | DecommissionRecord | WarrantyInformation | DeviceParameter | Other
example: Equipment | Machine | Implement | EquipmentType | EquipmentMake | EquipmentModel | Organization | TheftRecord | DecommissionRecord | WarrantyInformation | DeviceParameter | Other
discriminator:
propertyName: '@type'
equipment-make:
type: object
title: EquipmentMake
allOf:
- $ref: '#/components/schemas/resource'
- type: object
properties:
name:
type: string
example: JOHN DEERE
ERID:
type: string
example: db18bdc4-025a-11eb-97e4-0e8d658c7ba3
deprecated:
type: boolean
example: false
equipment-type:
type: object
title: EquipmentType
allOf:
- $ref: '#/components/schemas/resource'
- type: object
properties:
name:
type: string
example: Two-wheel Drive Tractors - 140 Hp And Above
ERID:
type: string
example: 82115264-9385-460c-bfbe-177a59445fd9
category:
type: string
enum:
- Machine
- Implement
- Unknown
certified:
type: boolean
example: true
icon:
type: string
example: icon
deprecated:
type: boolean
example: false
icon-style:
type: object
title: IconStyle
properties:
primaryColor:
type: string
secondaryColor:
type: string
equipment-icon:
type: object
title: EquipmentIcon
allOf:
- $ref: '#/components/schemas/resource'
- type: object
properties:
name:
type: string
example: JOHN DEERE
iconStyle:
$ref: '#/components/schemas/icon-style'
equipment-model:
type: object
title: EquipmentModel
allOf:
- $ref: '#/components/schemas/resource'
- type: object
properties:
name:
type: string
example: 8360R
ERID:
type: string
example: 158df9ff-334a-4e0d-86cc-3adca17a9686
category:
type: string
enum:
- Machine
- Implement
- Unknown
deprecated:
type: boolean
example: false
make:
$ref: '#/components/schemas/equipment-make'
type:
$ref: '#/components/schemas/equipment-type'
icon:
$ref: '#/components/schemas/equipment-icon'
organization-role:
type: object
title: OrganizationRole
properties:
type:
type: string
enum:
- Controlling
- NonControlling
effectiveTS:
type: string
format: date-time
event:
type: string
enum:
- CREATION
- TRANSFER
- SUBSCRIPTION
- PAIRING
- ORDER
- COMMANDED
- DECOMMISSION
abstractMeasurement:
type: object
title: AbstractMeasurement
properties:
type:
type: string
unit:
type: string
measurementAsDouble:
type: object
title: MeasurementAsDouble
allOf:
- $ref: '#/components/schemas/abstractMeasurement'
- type: object
properties:
type:
type: string
unit:
type: string
valueAsDouble:
type: number
format: double
variableRepresentationValue:
type: object
title: VariableRepresentationValue
properties:
variable:
$ref: '#/components/schemas/measurementAsDouble'
measurementAsString:
type: object
title: MeasurementAsString
allOf:
- $ref: '#/components/schemas/abstractMeasurement'
- type: object
properties:
type:
type: string
unit:
type: string
valueAsString:
type: string
definedTypeRepresentationValue:
type: object
title: DefinedTypeRepresentationValue
properties:
value:
$ref: '#/components/schemas/measurementAsString'
offsets:
type: object
title: Offsets
allOf:
- $ref: '#/components/schemas/resource'
- type: object
properties:
variableRepresentationValues:
type: array
items:
$ref: '#/components/schemas/variableRepresentationValue'
definedTypeRepresentationValues:
type: array
items:
$ref: '#/components/schemas/definedTypeRepresentationValue'
device-make:
type: object
title: DeviceMake
allOf:
- $ref: '#/components/schemas/resource'
- type: object
properties:
name:
type: string
example: JOHN DEERE
ERID:
type: string
example: db18bdc4-025a-11eb-97e4-0e8d658c7ba3
device-type:
type: object
title: DeviceType
allOf:
- $ref: '#/components/schemas/resource'
- type: object
properties:
name:
type: string
example: Modem
commonName:
type: string
example: TelematicsGateway
ERID:
type: string
example: db18bdc4-025a-11eb-97e4-0e8d658c7ba3
device-model:
type: object
title: DeviceModel
allOf:
- $ref: '#/components/schemas/resource'
- type: object
properties:
name:
type: string
example: JDLink Modem-4G
ERID:
type: string
example: db18bdc4-025a-11eb-97e4-0e8d658c7ba3
version:
type: object
title: Version
allOf:
- $ref: '#/components/schemas/resource'
- type: object
properties:
name:
type: string
example: 3.16.1171
inability-detail:
type: object
title: InabilityDetail
allOf:
- $ref: '#/components/schemas/resource'
- type: object
properties:
code:
type: string
example: RC14.8.1
type:
type: string
example: REGISTRATION
description:
type: string
example: SIM registration is required
capability:
type: object
title: Capability
allOf:
- $ref: '#/components/schemas/resource'
- type: object
properties:
capable:
type: boolean
capabilityDetails:
type: array
items:
$ref: '#/components/schemas/inability-detail'
equipment:
type: object
title: Equipment
allOf:
- $ref: '#/components/schemas/resource'
- type: object
properties:
name:
type: string
description: Equipment Name.
example: Cates 8360R 055358
serialNumber:
type: string
description: Serial Number of the Equipment and passed on the query parameter
example: 1RW8360RLCD055358
engineSerialNumber:
type: string
isSerialNumberCertified:
type: boolean
example: true
make:
$ref: '#/components/schemas/equipment-make'
type:
$ref: '#/components/schemas/equipment-type'
model:
$ref: '#/components/schemas/equipment-model'
organization:
$ref: '#/components/schemas/resource'
archived:
type: boolean
example: true
principalId:
type: string
description: Unique id for principal equipment
organizationRole:
$ref: '#/components/schemas/organization-role'
ERID:
type: string
description: |
Unique identifier of the Equipment.
example: fcdc83cb-8840-4215-84b5-1769889db932
icon:
$ref: '#/components/schemas/equipment-icon'
offsets:
$ref: '#/components/schemas/offsets'
devices:
items:
anyOf:
- $ref: '#/components/schemas/display'
- $ref: '#/components/schemas/position-receiver'
- $ref: '#/components/schemas/telematics-gateway'
capabilities:
type: array
items:
$ref: '#/components/schemas/capability'
pairingDetails:
$ref: '#/components/schemas/pairing-details'
point:
type: object
title: Point
properties:
lat:
type: number
format: double
lon:
type: number
format: double
slope:
type: number
format: double
pairing-details:
type: object
title: PairingDetails
properties:
paired:
type: boolean
associationTimestamp:
type: string
format: date-time
disassociationTimestamp:
type: string
format: date-time
confirmationTimestamp:
type: string
format: date-time
location:
$ref: '#/components/schemas/point'
device:
type: object
title: Device
allOf:
- $ref: '#/components/schemas/resource'
- type: object
properties:
serialNumber:
type: string
description: Serial number of the device and passed on the query parameter
example: PCS171B372381
make:
$ref: '#/components/schemas/device-make'
type:
$ref: '#/components/schemas/device-type'
model:
$ref: '#/components/schemas/device-model'
organization:
$ref: '#/components/schemas/resource'
ERID:
type: string
description: |
Unique identifier of the Device.
example: fcdc83cb-8840-4215-84b5-1769889db932
firmwareVersion:
$ref: '#/components/schemas/version'
capabilities:
type: array
items:
$ref: '#/components/schemas/capability'
equipment:
$ref: '#/components/schemas/equipment'
archived:
type: boolean
example: true
principalId:
type: string
description: Unique id for principal device
organizationRole:
$ref: '#/components/schemas/organization-role'
orderNumber:
type: string
pairingDetails:
$ref: '#/components/schemas/pairing-details'
display:
type: object
title: Display
allOf:
- $ref: '#/components/schemas/device'
- type: object
position-receiver:
type: object
title: PositionReceiver
allOf:
- $ref: '#/components/schemas/device'
- type: object
communication-module:
type: object
title: CommunicationModule
allOf:
- $ref: '#/components/schemas/resource'
- type: object
properties:
serialNumber:
type: string
description: Serial number of the communication gateway
example: PCS171B372381
imei:
type: string
imsi:
type: string
iccid:
type: string
msisdn:
type: string
eid:
type: string
type:
type: string
enum:
- GSM
- SATELLITE
- CDMA
- COS
serviceProvider:
type: string
enum:
- IRIDIUM
- ATT
- JASPER
- VERIZON
- COS
- COST
- CUBIC
- ATTIOT
state:
type: string
description: Subscription state of the communication gateway
enum:
- NEW
- ACTIVE
- INACTIVE
- EXPIRED
- PENDING_ACTIVE
- PENDING_INACTIVE
- PENDING_EXPIRED
- PENDING_VERIFICATION
- PENDING_WDT
- TERMINATED
telematics-gateway:
type: object
title: TelematicsGateway
allOf:
- $ref: '#/components/schemas/device'
- type: object
properties:
pairingStatus:
schema:
type: string
enum:
- PAIRED
- PENDING_PAIRING
orderNumber:
type: string
highFidelityConfigurationVersion:
$ref: '#/components/schemas/version'
genericConfigurationVersion:
$ref: '#/components/schemas/version'
decommissioned:
type: boolean
stolen:
type: boolean
communicationModules:
type: array