-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathAPDS_API_bundled.json
7497 lines (7496 loc) · 401 KB
/
APDS_API_bundled.json
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.0",
"info": {
"title": "APDS",
"version": "1.0",
"description": "Allows the standard CRUD operations, as well as listing/search of:\n\n* `Places` (and their `Occupancy`)\n* `Rates`\n* `RightSpecifications`\n* `AssignedRights`\n* `Sessions`\n* `Observations`\n\n**IMPORTANT**: This specification is a working **DRAFT**. Please **do not use it as the basis for APDS implementations at this stage**.",
"contact": {}
},
"tags": [
{
"name": "create",
"description": "Create a resource"
},
{
"name": "read",
"description": "Read a resource"
},
{
"name": "update",
"description": "Update a resource"
},
{
"name": "delete",
"description": "Delete a resource"
},
{
"name": "list",
"description": "Search and list resources"
},
{
"name": "example",
"description": "An example endpoint that data consumers should implement"
}
],
"servers": [
{
"url": ""
}
],
"paths": {
"/rights/assigned": {
"parameters": [],
"post": {
"summary": "Create a new AssignedRight",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1rates/post/responses/200/content/application~1json/schema"
},
"examples": {
"created": {
"value": {
"status": "ok"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1rates/post/responses/200/content/application~1json/schema"
},
"examples": {
"missing-data": {
"value": {
"status": "error",
"code": 400,
"message": "Missing required attributes"
}
}
}
}
}
}
},
"operationId": "create-assigned_right",
"description": "Create a new `AssignedRight` based on a given object or referencing a `Quote`",
"requestBody": {
"description": "This method allows an issuer to assign a parking right to a holder",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/paths/~1rights~1assigned~1%7Bid%7D/get/responses/200/content/application~1json/schema"
},
{
"title": "ReferenceToQuote",
"description": "Class defining a reference to a specific Quote",
"oneOf": [
{
"$ref": "#/paths/~1sessions~1%7Bid%7D/put/requestBody/content/application~1json/schema/oneOf/1"
},
{
"title": "ReferenceQuoteNew",
"type": "object",
"description": "Class providing a versioned reference to a new quote",
"properties": {
"quoteResponseId": {
"$ref": "#/paths/~1sessions/post/requestBody/content/application~1json/schema/allOf/1/properties/initiator"
},
"optionId": {
"$ref": "#/paths/~1sessions/post/requestBody/content/application~1json/schema/allOf/1/properties/initiator"
}
}
}
]
}
]
}
}
}
},
"tags": [
"create"
]
},
"get": {
"summary": "List and Search for AssignedRights",
"operationId": "list-assigned_rights",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1rates/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"description": "the actual data",
"properties": {
"data": {
"type": "array",
"description": "Result set with `AssignedRights` and requested expanded attributes",
"items": {
"$ref": "#/paths/~1rights~1assigned~1%7Bid%7D/get/responses/200/content/application~1json/schema"
}
}
}
}
]
}
}
}
}
},
"description": "Lists `AssignedRights` and allows searching/filtering by:\n\n* one or more `HolderCredentials` and `RightSpecifications`, to check if given credentials have any of the given rights to park\n* latitude, longitude, radius: to check for `AssignedRights` within a geographic area\n* a list of `Places`, to retrieve all assigned rights within a set of parking locations\n* start_before: to get sessions starting before a given instant\n* end_before: to get sessions ending before a given instant\n* start_after: to get sessions starting after a given instant\n* end_after: to get sessions ending after a given instant\n* a modification instant: to only display changed resources from that point onwards\n\nAdditionally, supports providing a comma-separated list of optional object attributes associated to an `AssignedRight` that should be included in the result set. If unused or left blank, `none` will be assumed.",
"tags": [
"list"
],
"parameters": [
{
"$ref": "#/components/parameters/right_specs_list"
},
{
"$ref": "#/components/parameters/cred_type"
},
{
"$ref": "#/components/parameters/cred_class_list"
},
{
"$ref": "#/components/parameters/cred_id_list"
},
{
"$ref": "#/components/parameters/place_list"
},
{
"$ref": "#/components/parameters/assigned_expand"
},
{
"$ref": "#/components/parameters/lat"
},
{
"$ref": "#/components/parameters/long"
},
{
"$ref": "#/components/parameters/radius"
},
{
"$ref": "#/components/parameters/mod"
},
{
"$ref": "#/components/parameters/start_before"
},
{
"$ref": "#/components/parameters/end_before"
},
{
"$ref": "#/components/parameters/start_after"
},
{
"$ref": "#/components/parameters/end_after"
}
]
}
},
"/rights/assigned/{id}": {
"parameters": [
{
"schema": {
"type": "string"
},
"name": "id",
"in": "path",
"description": "Identifier for the `AssignedRight`",
"required": true
}
],
"delete": {
"summary": "Delete AssignedRight",
"operationId": "delete-assigned_right",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1rates/post/responses/200/content/application~1json/schema"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1rates/post/responses/200/content/application~1json/schema"
},
"examples": {
"bad-request": {
"value": {
"status": "error",
"code": 400,
"message": "Did not provide version number"
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1rates/post/responses/200/content/application~1json/schema"
},
"examples": {
"not-found": {
"value": {
"status": "error",
"code": 404,
"message": "Not found"
}
}
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1rates/post/responses/200/content/application~1json/schema"
},
"examples": {
"conflict": {
"value": {
"status": "error",
"code": 409,
"message": "Outdated version number provided"
}
}
}
}
}
}
},
"tags": [
"delete"
],
"description": "Delete an existing `Assigned Right`"
},
"put": {
"summary": "Update AssignedRight",
"operationId": "update-assigned_right",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1rates/post/responses/200/content/application~1json/schema"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1rates/post/responses/200/content/application~1json/schema"
},
"examples": {
"missing-data": {
"value": {
"status": "error",
"code": 400,
"message": "Missing required attributes"
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1rates/post/responses/200/content/application~1json/schema"
},
"examples": {
"not-found": {
"value": {
"status": "error",
"code": 404,
"message": "Not found"
}
}
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1rates/post/responses/200/content/application~1json/schema"
},
"examples": {
"conflict": {
"value": {
"status": "error",
"code": 409,
"message": "Outdated version number provided"
}
}
}
}
}
}
},
"description": "Update an existing `AssignedRight` based on its object or with reference to a `Quote`. If the Quote refers to a Session Extension, this request shall also update the referenced Session",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/paths/~1rights~1assigned~1%7Bid%7D/get/responses/200/content/application~1json/schema"
},
{
"$ref": "#/paths/~1rights~1assigned/post/requestBody/content/application~1json/schema/oneOf/1"
}
]
}
}
},
"description": "The new version of the `AssignedRight`, including only its changed attributes"
},
"tags": [
"update"
]
},
"get": {
"summary": "Get an AssignedRight",
"operationId": "read-assigned_right",
"description": "Get latest version of a given `AssignedRight` by its identifier (or a particular previous version when provided as a query parameter)",
"tags": [
"read"
],
"parameters": [
{
"$ref": "#/components/parameters/version"
},
{
"$ref": "#/components/parameters/assigned_expand"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "AssignedRight",
"x-tags": [
"rights"
],
"description": "AssignedRight indicates the granting of a specific RightSpecification to a specific RightHolder,and indicates one instance of a planned use of the Right.",
"allOf": [
{
"$ref": "#/paths/~1rates/post/requestBody/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"rightHolder": {
"title": "RightHolder",
"type": "object",
"x-tags": [
"rights"
],
"description": "Information concerning a specific holder of a granted right, corresponding to a defined RightSpecification.",
"properties": {
"credentials": {
"type": "array",
"items": {
"$ref": "#/paths/~1sessions/post/requestBody/content/application~1json/schema/allOf/1/properties/identifiedCredentials/items"
}
}
}
},
"rightSpecification": {
"$ref": "#/paths/~1sessions/post/requestBody/content/application~1json/schema/allOf/1/properties/initiator"
},
"expiry": {
"type": "string",
"format": "date-time",
"description": "The date/time when the specific AssignedRight expires, and is not longer available for use"
},
"issuanceTime": {
"type": "string",
"format": "date-time",
"description": "The date/time of the issuing of a specific AssignedRight."
},
"assignedRightIssuer": {
"$ref": "#/paths/~1webhooks/post/requestBody/content/application~1json/schema/properties/hierarchyElements/items"
},
"instancesAvailable": {
"type": "integer",
"description": "The total number of instances under a specified RightSpecification that are available for use."
},
"instancesUsed": {
"type": "integer",
"description": "The total number of instances under a specified RightSpecification that have been used."
},
"minutesUsed": {
"type": "number",
"description": "Number of minutes under a specified Assigned Right that have been used.\nDecimal minutes",
"format": "float"
},
"minutesAvailable": {
"type": "number",
"description": "Number of minutes under a specified Assigned Right that are available for use.\nDecimal minutes. Remaining time.",
"format": "float"
},
"remainingValue": {
"title": "AmountInCurrency",
"type": "object",
"description": "A class supporting the definition of a unit of currency in a defined currency.",
"properties": {
"currencyType": {
"$ref": "#/paths/~1rates/get/responses/200/content/application~1json/schema/allOf/1/properties/data/items/allOf/1/properties/rateLineCollections/items/anyOf/0/properties/applicableCurrency"
},
"currencyValue": {
"type": "number",
"description": "The amount of currency specified in the given currency code type.",
"format": "float"
}
},
"required": [
"currencyType",
"currencyValue"
]
},
"totalInstances": {
"type": "integer",
"description": "The total number of instances under a specified Assigned Right that have been issued."
},
"totalMinutes": {
"type": "number",
"description": "Number of minutes under a specified Assigned Right that have been issued. Decimal minutes",
"format": "float"
},
"totalRightValue": {
"$ref": "#/paths/~1rights~1assigned~1%7Bid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/remainingValue"
},
"issueMethod": {
"type": "string",
"title": "IssueMethodEnum",
"enum": [
"electronic",
"ticket",
"permit"
],
"x-tags": [
"enumeration",
"credentials"
],
"description": "A list of the supported methods for issuing credentials.\n\n* `electronic`: electronically issued, traceable\n* `permit`: physical identifier, typically visibly mounted within vehicle\n* `ticket`: typically single use, paper based"
},
"plannedUses": {
"type": "array",
"description": "Planned future uses of this `AssignedRight`",
"items": {
"title": "PlannedUse",
"type": "object",
"description": "A specific future instance when an `AssignedRight` is to be used/initiated.",
"x-tags": [
"rights"
],
"properties": {
"startTime": {
"type": "string",
"format": "date-time",
"description": "Date/time instance when a `PlannedUse` is considered to start, and be available for\nuse."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "Date/time instance when a `PlannedUse` is considered to end, and no longer be\navailable for use."
},
"expiryTime": {
"type": "string",
"format": "date-time",
"description": "Date/time instance when a `PlannedUse` expires, and is no longer available for use."
},
"cancelTime": {
"type": "string",
"description": "Date/time instance when a specific `Planned Use` has been cancelled by the right holder.",
"format": "date-time"
},
"issuanceTime": {
"type": "string",
"format": "date-time",
"description": "Date/time at which a specific `PlannedUse` instance was issued."
},
"issueMethod": {
"$ref": "#/paths/~1rights~1assigned~1%7Bid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/issueMethod"
},
"issuer": {
"$ref": "#/paths/~1sessions/post/requestBody/content/application~1json/schema/allOf/1/properties/initiator"
},
"credentialsAssigned": {
"type": "array",
"minItems": 1,
"description": "Credentials that might be used",
"items": {
"title": "CredentialAssigned",
"description": "Information concerning a specific credential that is used for verification for one AssignedRight. Specialisation of a general credential.",
"allOf": [
{
"type": "object",
"properties": {
"identifier": {
"$ref": "#/paths/~1webhooks/post/requestBody/content/application~1json/schema/properties/hierarchyElements/items"
},
"issuer": {
"$ref": "#/paths/~1rates/post/requestBody/content/application~1json/schema/allOf/1/properties/rateTableID"
}
},
"required": [
"identifier",
"issuer"
]
},
{
"$ref": "#/paths/~1rights~1specs/post/requestBody/content/application~1json/schema/allOf/1/properties/credentials/items"
}
],
"x-tags": [
"rights"
]
}
}
},
"required": [
"startTime"
]
}
},
"payments": {
"type": "array",
"description": "Payments made for this AssignedRight",
"items": {
"title": "Payment",
"description": "Lightweight record of payment for associated AssignedRight (temporary)",
"allOf": [
{
"$ref": "#/paths/~1rates/post/requestBody/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"dateCollected": {
"type": "string",
"description": "Date / time that the payment related to this financial transaction is recorded as being paid and collected",
"format": "date-time"
},
"paymentType": {
"type": "string",
"title": "PaymentTypeEnum",
"enum": [
"payment",
"validation"
],
"description": "Indicates the nature of the payment made against an AssignedRight.\n\n* `payment`: Indicates financial payment made\n* `validation`: Indicates financial value offset through use of validation coupon or similar"
},
"serviceProvider": {
"$ref": "#/paths/~1sessions/post/requestBody/content/application~1json/schema/allOf/1/properties/initiator"
},
"taxIncluded": {
"type": "boolean",
"description": "Whether tax included in monetary value, if yes (TRUE), if not (FALSE)."
},
"transactionID": {
"type": "string",
"description": "Identifier for the transaction (e.g. reservation number, credit card transaction reference) as agreed upon by the two entities sharing data."
},
"value": {
"$ref": "#/paths/~1rights~1assigned~1%7Bid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/remainingValue"
}
},
"required": [
"paymentType",
"serviceProvider",
"taxIncluded",
"value"
]
}
]
}
},
"monetaryValue": {
"title": "MonetaryValue",
"type": "object",
"description": "Lightweight record of the monetary financial value of the associated AssignedRight (temporary). Service provider is entity responsible for selling/collecting fees associated to the AR.",
"properties": {
"taxIncluded": {
"type": "boolean",
"description": "Whether tax included in monetary value, if yes (TRUE), if not (FALSE)."
},
"serviceProvider": {
"$ref": "#/paths/~1sessions/post/requestBody/content/application~1json/schema/allOf/1/properties/initiator"
},
"value": {
"$ref": "#/paths/~1rights~1assigned~1%7Bid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/remainingValue"
}
},
"required": [
"taxIncluded",
"serviceProvider",
"value"
]
}
},
"required": [
"rightHolder",
"rightSpecification"
]
}
]
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1rates/post/responses/200/content/application~1json/schema"
}
}
}
}
}
}
},
"/rights/specs": {
"get": {
"summary": "List and search for RightSpecifications",
"tags": [
"list"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1rates/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Result set with `RightSpecifications` and requested expanded attributes",
"items": {
"$ref": "#/paths/~1rights~1specs/post/requestBody/content/application~1json/schema"
}
}
}
}
]
}
}
}
}
},
"operationId": "list-rights-specs",
"description": "Lists `RightSpecifications` and allows filtering by:\n\n* latitude, longitude, radius: to check for `RightSpecifications` within a geographic area\n* a `Place`, to retrieve all assigned rights within a parking location\n* a modification instant: to only display changed resources from that point onwards\n\nAdditionally, supports providing a comma-separated list of optional object attributes associated to an `RightSpecification` that should be included in the result set. If unused or left blank, `none` will be assumed.",
"parameters": [
{
"$ref": "#/components/parameters/lat"
},
{
"$ref": "#/components/parameters/long"
},
{
"$ref": "#/components/parameters/radius"
},
{
"$ref": "#/components/parameters/specs_expand"
},
{
"$ref": "#/components/parameters/mod"
},
{
"$ref": "#/components/parameters/cred_type"
},
{
"$ref": "#/components/parameters/place_list"
}
]
},
"post": {
"summary": "Create a new RightSpecification",
"operationId": "post-rights-specs",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1rates/post/responses/200/content/application~1json/schema"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1rates/post/responses/200/content/application~1json/schema"
}
}
}
}
},
"tags": [
"create"
],
"description": "Create a new `RightSpecification`",
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "RightSpecification",
"description": "A Right Specification explicitly defines what the owner/manager of a Place is granting specific users or vehicles the ability to do (e.g. park, delivery, pick up).",
"x-tags": [
"rights"
],
"allOf": [
{
"$ref": "#/paths/~1rates/post/requestBody/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"description": {
"$ref": "#/paths/~1rates/post/requestBody/content/application~1json/schema/allOf/1/properties/rateTableID"
},
"expiry": {
"type": "string",
"format": "date-time",
"description": "Date/time showing the timestamp for when a RightSpecification ceases to be valid."
},
"financialReference": {
"type": "string",
"description": "Creator defined free-text reference to financial transactions associated to the specific Right Specification."
},
"issuer": {
"$ref": "#/paths/~1sessions/post/requestBody/content/application~1json/schema/allOf/1/properties/initiator"
},
"transferable": {
"type": "boolean"
},
"transferableConditions": {
"type": "boolean"
},
"type": {
"$ref": "#/components/parameters/right_type/schema/items"
},
"hierarchyElements": {
"type": "array",
"minItems": 1,
"description": "Versioned references to `Places` in the hierarchy where this `RightSpecification` is available",
"items": {
"$ref": "#/paths/~1sessions/post/requestBody/content/application~1json/schema/allOf/1/properties/initiator"
}
},
"credentials": {
"type": "array",
"description": "The allowed credential types for this `RightSpecification`",
"items": {
"title": "Credential",
"type": "object",
"x-tags": [
"credentials",
"rights"
],
"description": "Information relating to a form of credential that are applicable for a specific RightSpecification.",
"properties": {
"type": {
"$ref": "#/components/parameters/cred_type/schema/items"
}
}
}
},
"rateEligibility": {
"type": "array",
"description": "Defines the combination of `Eligibility` requirements with `RateTables` and associates this combination to a `RightSpecification`. RateEligibility enables a `RightSpecification` to have association to multiple `RateTable(s)` for a specific `Eligibility` ( or set of `Qualifications`). `RateEligibility` also defines if `RateTables` are `Combinable`. This is a Yes / No (Boolean) definition. Either all `RateTables` associated to a `RightSpecification` with a common `Eligibility` can be combined or they cannot.",
"items": {
"title": "RateEligibility",
"x-tags": [
"rights"
],
"description": "Defines the combination of Eligibility requirements with RateTables and associates this combination to a RightSpecification.",
"allOf": [
{
"$ref": "#/paths/~1rates/post/requestBody/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"priority": {
"type": "integer",
"description": "An integer value, starting at 1, indicating the order in which multiple relevant\nRateTables shall be considered, with 1\nbeing the highest priority.",
"minimum": 1
},
"combinable": {
"type": "boolean",
"description": "Boolean attribute that indicates (TRUE) if all `RateTables` associated to a `RightSpecification` with a common `Eligibility` can be combined to establish a lowest cost tariff or (FALSE) they cannot be combined."
},
"eligibility": {
"$ref": "#/paths/~1quotes/post/requestBody/content/application~1json/schema/oneOf/0/allOf/1/properties/eligibility"
},
"rateTable": {
"$ref": "#/paths/~1sessions/post/requestBody/content/application~1json/schema/allOf/1/properties/initiator"
},
"rateDiscount": {
"title": "RateDiscount",
"type": "object",
"description": "Class defining discount rates to be applied to a RateTable",
"properties": {
"fixedValue": {
"$ref": "#/paths/~1rights~1assigned~1%7Bid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/remainingValue"
},
"discountRate": {
"type": "number",
"minimum": 0,
"maximum": 100,
"format": "float",
"description": "proportionate discount (-) or surcharge (+) to be applied to all values in the referenced RateTable "
}
}
}
},
"required": [
"eligibility"
]
}
]
}
},
"rightPools": {
"type": "array",
"description": "Shares the number of AssignedRights that are available for use, are currently in use, or intended for use within a specific RightSpecification in specific date/time periods by a specific AssignedRightIssuer",
"items": {
"title": "RightPool",
"x-tags": [
"rights"
],
"allOf": [
{
"$ref": "#/paths/~1rates/post/requestBody/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"assignedRightsIssuer": {
"$ref": "#/paths/~1sessions/post/requestBody/content/application~1json/schema/allOf/1/properties/initiator"
},
"availableAssignedRights": {
"description": "The number of Assigned Rights that have been issued by the Rights creator to a specific Rights Issuer that are still available to be assigned.",
"type": "integer"
},
"distributedAssignedRights": {
"description": "The number of Assigned Rights that have been issued by the Rights creator to a specific Rights Issuer",
"type": "integer"
},
"qtyRelation": {
"type": "integer",
"description": "An integer defining the number of actions or parking included in a `RightSpecification`"
},
"relativeValidity": {
"title": "RelativeValidity",
"type": "object",
"x-tags": [
"rights",
"validity"
],
"description": "A specific calendar can be defined to represent the number of `AssignedRights` available for distribution in a specific recurring time period via `RelativeValidity`.",
"properties": {
"period": {
"title": "Period",
"type": "object",
"description": "A continuous time period or a set of discontinuous time periods defined by the intersection of a set of criteria all within an overall delimiting interval.",
"x-tags": [
"times"
],
"properties": {
"periodName": {
"$ref": "#/paths/~1rates/post/requestBody/content/application~1json/schema/allOf/1/properties/rateTableID"
},
"startOfPeriod": {
"type": "string",
"format": "date-time",
"description": "Start of period"
},
"endOfPeriod": {
"type": "string",
"description": "End of a period",
"format": "date-time"
},
"recurringDayWeekMonthPeriod": {
"type": "array",
"description": "A recurring period defined in terms of days `DayWeekMonth` of the week, weeks of the month and months of the year.",
"items": {
"title": "DayWeekMonth",
"type": "object",
"description": "Specification of periods defined by the intersection of days, weeks and months.",
"x-tags": [
"times"
],
"properties": {
"applicableDay": {
"type": "array",
"uniqueItems": true,
"maxItems": 7,
"description": "Applicable day of the week. \"All days of the week\" is expressed by non-inclusion of\nthis attribute.",
"items": {
"type": "string",
"title": "DayEnum",
"enum": [
"friday",
"monday",
"saturday",
"sunday",
"thursday",
"tuesday",
"wednesday"
],
"description": "Defines permissible enumerations of identification of days within a week\n\n* `friday`: Friday\n* `monday`: Monday\n* `saturday`: Saturday\n* `sunday`: Sunday\n* `thursday`: Thursday\n* `tuesday`: Tuesday\n* `wednesday`: Wednesday"
}
},
"applicableMonth": {
"type": "array",
"description": "Applicable month of the year. \"All months of the year\" is expressed by non-inclusion of this attribute.",