-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathorder.yaml
1606 lines (1571 loc) · 49.2 KB
/
order.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
###############################################################################
## ##
## ORDER API ##
## ##
## (c) Airbus Defence and Space Geo ##
## ##
## ##
## Contact: [email protected] ##
## ##
###############################################################################
info:
title: Airbus Defence and Space Geo - Order API
description:
<p>This document describes Airbus Defence and Space Geo Order API. The Order API can be used to order products.<br />
__IMPORTANT -__ You should follow the [Geo APIs recommendations](/api-docs/recommendations.html) when implementing clients.</p>
<p>You can consult the [version log](/api-docs/order/CHANGELOG.html) for information about modification history.</p>
<p>__STANDARD RULES -__ The following rules apply to attributes format when specifyed.</p>
<p>Intervals for numerical values and dates are specified using the standard straights brackets.<br />
<ul><li>* [n1,n2] equal to n1 <= field <= n2</li>
<li>* [n1,n2[ equals to n1 <= field < n2</li>
<li>* ]n1,n2[ equals to n1 < field < n2</li>
<li>* ]n1,n2] equal to n1 < field <= n2</li>
<li>* [n1 equals to n1 <= field</li>
<li>* ]n1 equals to n1 < field</li>
<li>* n1] equals to field <= n1</li>
<li>* n1[ equals to field < n1 </li> </ul></p>
version: '1.0'
###############################################################################
## ##
## GENERAL CONFIGURATION ##
## ##
###############################################################################
swagger: "2.0"
#info:
consumes:
- application/json
produces:
- application/json
host: order-qual.geoapi-airbusds.com:8443
basePath: "/"
schemes:
- "https"
securityDefinitions:
api_key:
description: A recognised anthentication API key for a named system user.
in: header
name: Authorization
type: apiKey
###############################################################################
## ##
## OBJECTS DOCUMENTATION ##
## ##
###############################################################################
definitions:
AoiGeometry:
type: object
properties:
type:
type: string
coordinates:
format: "[[[1.0, 1.0],[2.0,1.0]]]"
format: GeoJSON
description: Area Of Interest defined by a simple polygon in GeoJSON format
ProgTypeName:
type: string
description: refer to one-tasking online documentation at http://www.intelligence-airbusds.com/ for more information
enum:
- ONEDAY
- ONENOW
- ONEPLAN
- ONESERIES
IsoDate:
type: string
format: ISO-8601
description: date string in ISO-8601 format 'YYYY-MM-DDTHH:mm:ssZ'
DateRange:
type: object
properties:
startDate:
$ref: '#/definitions/IsoDate'
endDate:
$ref: '#/definitions/IsoDate'
Currency:
type: string
format: ISO 4217
enum:
- EUR
- USD
MissionName:
type: string
description: Constellation Name
enum:
- SPOT
- PLEIADES
ProgCapacityResponseGeoconnector:
type: object
properties:
progCapacity:
type: array
items:
$ref: '#/definitions/ProgCapacity'
description: response from the ProgServer to the request of programming capacity.
ProgOptionsResponse:
type: object
properties:
progCapacityOptions:
type: array
items:
$ref: '#/definitions/ProgCapacityOptions'
description: response from the ProgServer to the request of programming options.
ProgCapacityOptions:
type: object
properties:
mission:
type: string
progCapacityOptions:
type: array
items:
$ref: '#/definitions/ProgTypeOptions'
ProgTypeOptions:
type: object
properties:
progTypeName:
$ref: '#/definitions/ProgTypeName'
progOptionsOptical:
$ref: '#/definitions/ProgOptions'
# progOptionsRadar:
# $ref: '#/definitions/ProgOptionsTsx'
# ProgOptionsTsx:
# type: object
# properties:
# advancedOptions:
# $ref: '#/definitions/TsxAdvancedOptions'
# standardOptions:
# type: array
# items:
# $ref: '#/definitions/TsxStandardOptions'
# TsxAdvancedOptions:
# type: object
# properties:
# incidenceAngle:
# $ref: '#/definitions/TsxOption'
# orbitDirection:
# $ref: '#/definitions/TsxOption'
# instrumentMode:
# $ref: '#/definitions/TsxOption'
# polarizationMode:
# $ref: '#/definitions/TsxOption'
# antennaLookDirection:
# $ref: '#/definitions/TsxOption'
# bandwidth:
# $ref: '#/definitions/TsxOption'
# application:
# type: string
# applicationGroup:
# type: string
# purpose:
# type: string
# productTypeId:
# type: string
# TsxStandardOptions:
# type: object
# properties:
# applicationOptions:
# type: array
# items:
# $ref: '#/definitions/TsxApplicationOptions'
# applicationGroup:
# type: string
# purpose:
# type: string
# productTypeId:
# type: string
# TsxApplicationOptions:
# type: object
# properties:
# options:
# type: array
# items:
# $ref: '#/definitions/TsxOption'
# application:
# type: string
# TsxOption:
# type: object
# properties:
# name:
# type: string
# type:
# type: string
# constraint:
# type: string
# productTypeId:
# type: string
# mandatory:
# type: boolean
# values:
# type: array
# items:
# $ref: '#/definitions/TsxOptionsValue'
# format:
# type: string
# defaultValue:
# type: string
# TsxOptionsValue:
# type: object
# properties:
# code:
# type: string
# constraint:
# type: string
OptionsRequest:
type: object
properties:
aoi:
type: array
items:
$ref: '#/definitions/OptionsAoi'
categoryFilter:
type: string
enum:
- CATEGORY_TECHNICAL_PRODUCT
- CATEGORY_PROPERTIES
- NO_CATEGORY
description: input of the Get Options request. Contains a list of areas of interest with their ID (mandatory to return the projection option) and a filter to get the expected productType options (CATEGORY_TECHNICAL_PRODUCT), the expected item properties (CATEGORY_PROPERTIES) or all options/properties (NO_CATEGORY). By default the category filter is set to CATEGORY_TECHNICAL_PRODUCT.
example: {
aoi: [ {
polygonId: 1,
geometry: {
type: 'Polygon',
coordinates: [[8.492431640625004, 43.04480541304369],[9.591064453125002, 43.04480541304369],
[9.591064453125002, 41.10419094457646], [8.492431640625004, 41.10419094457646],[8.492431640625004, 43.04480541304369]]
}
}
]
}
OptionsPerProductType:
type: object
properties:
productTypeId:
type: string
licence:
type: string
options:
type: array
items:
$ref: '#/definitions/Property'
description: defines the production options and licence for a productType. Contains the productType identifier, the licence identifier, and a list of the selected production options (key/value for each option corresponding to Option.name/OptionListItem.id or Option.name/value of expected option).
example: {
productType: "PleiadesArchiveMono",
licence: "eula_5",
options: [
{
key: "processing_level",
value: "primary"
}
]
}
PriceResponse:
type: object
properties:
contractId:
type: string
description: Contract identifier.
currency:
$ref: '#/definitions/Currency'
discountPercentage:
type: number
format: double
description: Discount percent at total level.
discountValue:
type: number
format: double
description: Discount value at total level.
productTypes:
type: array
items:
$ref: '#/definitions/PriceItem'
totalAmount:
type: number
format: double
description: Work order total amount (valued in contract currency).
description: Provices price(s) estimate for a work order.
Property:
type: object
properties:
key:
type: string
value:
type: string
Contracts:
type: object
properties:
contracts:
type: array
items:
$ref: '#/definitions/Contract'
description: list of all the contracts linked to the user.
Aoi:
type: object
description: Area Of Interest. Contains the ID of the AOI, the GeoJSON coordinates and the name to use in invoice.
properties:
id:
type: integer
format: int32
geometry:
$ref: '#/definitions/AoiGeometry'
name:
type: string
ProgCapacity:
type: object
properties:
mission:
$ref: '#/definitions/MissionName'
progTypes:
type: array
items:
$ref: '#/definitions/ProgType'
description: item of the response from the ProgServer to the request of programming capacity.
OptionsAoi:
type: object
properties:
polygonId:
type: string
geometry:
$ref: '#/definitions/AoiGeometry'
description: the Area Of Interest definition to give in Get Options request. Contains the GeoJSON coordinates and the ID of the AOI (Get Options returns for each AOI an option with the name projection_[aoiId] with a specific list of available projection codes).
DateValueOption:
type: object
properties:
allowedValue:
type: array
items:
type: string
defaultValue:
type: string
PriceItem:
type: object
properties:
amount:
type: number
format: double
description: Amount (valued in contract currency) after discount.
areaKm2:
type: number
format: double
description: Total area surface relevant for the product offer.
discountPercentage:
type: number
format: double
description: Discount percent applied on price.
discountValue:
type: number
format: double
description: Discount value applied on price.
price:
type: number
format: double
description: Price (valued in contract currency).
productTypeId:
type: string
description: total amount in defined currency and with discount.
items:
type: array
items:
$ref: '#/definitions/WorkOrderItemPriceRef'
vouchercode:
type: string
description: Voucher code.
description: Define price informations for work order item of priceResponse.
OrderRequest:
type: object
properties:
aoi:
type: array
items:
$ref: '#/definitions/Aoi'
contractId:
type: string
items:
type: array
items:
$ref: '#/definitions/WorkOrderItem'
primaryMarket:
type: string
enum:
- AGRI
- ASSUR
- AUTRE
- CARTO
- DEFSEC
- DISTRI
- ENERGIE
- ENV
- FORET
- GDPUBLIC
- GENIE
- MARITIME
- MOBIL
- NQUAL
- PRESSE
- RISQUE
- SANTE
- TELECOM
- TOURISME
- TRANSPORT
secondaryMarket:
type: string
enum:
- AGRI_AUTRE
- AGRI_CTRL
- AGRI_ENV
- AGRI_INT
- AGRI_NQ
- AGRI_PREC
- AGRI_PROD
- AGRI_SI
- ASSUR
- AUTRE
- CARTO_AUTRE
- CARTO_CAD
- CARTO_NQ
- CARTO_RSMT
- CARTO_THEM
- CARTO_TOPO
- DEFSEC_AUTRE
- DEFSEC_CARTO
- DEFSEC_GEO
- DEFSEC_INT
- DEFSEC_NQ
- DEFSEC_RSGNT
- DISTRI
- ENERGIE_AUTRE
- ENERGIE_ECO
- ENERGIE_ENV
- ENERGIE_EXPLOIT
- ENERGIE_INFRA
- ENERGIE_NQ
- ENERGIE_PROD
- ENV_AUTRE
- ENV_EAU
- ENV_NQ
- ENV_SURV
- FORET_AUTRE
- FORET_CARB
- FORET_DEFOR
- FORET_ECO
- FORET_EXPLOIT
- FORET_INV
- FORET_NQ
- GDPUBLIC
- GENIE
- MARITIME_AUTRE
- MARITIME_CTRL
- MARITIME_ENV
- MARITIME_NQ
- MARITIME_ROUT
- MARITIME_RSGNT
- MOBIL_AUTRE
- MOBIL_COMM
- MOBIL_GDPUB
- MOBIL_INSTIT
- MOBIL_NQ
- NQUAL
- PRESSE
- RISQUE_ANTICIP
- RISQUE_AUTRE
- RISQUE_CRISE
- RISQUE_NQ
- RISQUE_POST
- RISQUE_PREV
- SANTE
- TELECOM
- TELECOM_AUTRE
- TELECOM_NQ
- TOURISME
- TOURISME_AUTRE
- TOURISME_NQ
- TRANSPORT
customerReference:
type: string
options:
type: array
items:
$ref: '#/definitions/Property'
optionsPerProductType:
type: array
items:
$ref: '#/definitions/OptionsPerProductType'
voucherCodes:
type: array
uniqueItems: true
items:
type: string
description: the WorkOrder to compute for price calculation or ordering. Contains a list of AOI, a list of WorkOrderItems, commercial data, a list of global options (key/value, with the mandatory deliveryType/network pair), the list of production options for each productType and a list of voucher codes.
example: {
aoi: [
{
id: 1,
geometry: {
type: 'Polygon',
coordinates: [[8.492431640625004, 43.04480541304369],[9.591064453125002, 43.04480541304369],
[9.591064453125002, 41.10419094457646], [8.492431640625004, 41.10419094457646],[8.492431640625004, 43.04480541304369]]
},
name: "test_for_partners"
}
],
contractId: "toBeDefined",
items: [
{
datastripIds: [
"40582651209160926432R5"
],
aoiId: 1,
productTypeId: "SPOTArchive10Color",
properties: []
}
],
primaryMarket: "AGRI",
secondaryMarket: "AGRI_ENV",
customerReference: "The order reference that will appear in invoicing",
options: [
{
key: "deliveryType",
value: "network"
}
],
optionsPerProductType: [
{
productTypeId: "SPOTArchive10Color",
licence: "eula_5",
options: [
{
key: "image_format",
value: "dimap_geotiff"
},
{
key: "projection_1",
value: "32632"
},
{
key: "processing_level",
value: "level_3"
}
]
}
],
voucherCodes: [
]
}
Voucher:
type: object
properties:
code:
type: string
period:
$ref: '#/definitions/DateRange'
amount:
type: number
format: double
currency:
$ref: '#/definitions/Currency'
consumed:
type: boolean
default: false
description: a payment method. Contains the code identifying this voucher, its period of validity, amount and currency, and if it is already consumed.
OrderResponse:
type: object
properties:
salesOrderId:
type: string
currency:
type: string
discountPercentage:
type: number
format: double
discountValue:
type: number
format: double
totalAmount:
type: number
format: double
description: response to the order service. Contains the identifier for order follow-up.
AvailableOptions:
type: object
properties:
availableOptions:
type: array
items:
$ref: '#/definitions/Option'
description: the response to the Get Options service. Returns a list of expected options of production and/or item properties
WorkOrderItemPriceRef:
type: object
properties:
datastripIds:
type: array
items:
type: string
description: Datastrip identifier.
description: Work order informations returned for getPrice.
OnePlanStandardOptions:
type: object
properties:
acquisitionPeriod:
$ref: '#/definitions/DateRange'
maxCloudCover:
$ref: '#/definitions/ValueOption'
maxIncidenceAngle:
$ref: '#/definitions/ValueOption'
comment:
$ref: '#/definitions/ValueOption'
description: options for Automatic OnePlan tasking capacity.
ProgOptions:
type: object
properties:
maxIncidenceAngleExtended:
type: number
format: double
maxIncidenceAngleNotExtended:
type: number
format: double
# extendedAngle:
# $ref: '#/definitions/ValueOption'
# acquisitionPeriod:
# $ref: '#/definitions/DateValueOption'
# maxCloudCover:
# $ref: '#/definitions/ValueOption'
# maxIncidenceAngle:
# $ref: '#/definitions/ValueOption'
# priority:
# $ref: '#/definitions/ValueOption'
# stereoMode:
# $ref: '#/definitions/ValueOption'
# tristereoMode:
# $ref: '#/definitions/ValueOption'
# acquisitionDuration:
# $ref: '#/definitions/ValueOption'
# temporalMode:
# $ref: '#/definitions/ValueOption'
# minBH:
# $ref: '#/definitions/ValueOption'
# maxBH:
# $ref: '#/definitions/ValueOption'
# acquisitionMode:
# $ref: '#/definitions/ValueOption'
# nbacquisitionRegularacquisition:
# $ref: '#/definitions/ValueOption'
# minIntervalRegularacquisition:
# $ref: '#/definitions/ValueOption'
# advancedOptions:
# $ref: '#/definitions/OnePlanAdvancedOptions'
# standardOptions:
# $ref: '#/definitions/OnePlanStandardOptions'
description: options returned by the ProgServer for tasking capacity.
ProgType:
type: object
properties:
name:
$ref: '#/definitions/ProgTypeName'
mission:
$ref: '#/definitions/MissionName'
expirationDate:
$ref: '#/definitions/IsoDate'
successRate:
description: percentage of success rate
type: number
format: float
progOptions:
$ref: '#/definitions/ProgOptions'
segments:
type: array
items:
$ref: '#/definitions/Segment'
extendedAngleNotAllowed0020:
type: array
items:
$ref: '#/definitions/Segment'
extendedAngleAllowed:
type: array
items:
$ref: '#/definitions/Segment'
feasibility:
$ref: '#/definitions/Feasibility'
Segment:
type: object
properties:
footprint:
$ref: '#/definitions/Footprint'
acquisitionStartTime:
$ref: '#/definitions/IsoDate'
acquisitionStopTime:
$ref: '#/definitions/IsoDate'
acquisitionMethod:
$ref: '#/definitions/AcquisitionMethod'
# incidenceAngle:
# type: number
# format: double
# extendedAngle:
# type: boolean
# default: false
orderDeadline:
$ref: '#/definitions/IsoDate'
# taskingProperties:
# type: string
AcquisitionMethod:
type: object
properties:
instrument:
type: string
acquisitionParameters:
$ref: '#/definitions/AcquisitionParameters'
AcquisitionParameters:
type: object
properties:
incidence:
type: number
format: double
extendedAngle:
type: boolean
default: false
Footprint:
type: object
properties:
geometry:
type: string
center:
type: string
ProductType:
type: object
properties:
productTypeId:
type: string
minimumAreaOrderApplied:
type: number
format: double
descriptionUrl:
type: string
description: the commercial product offer. Contains the minimum are to order a product of this type and an URL displaying the description of this product.
ProductTypes:
type: object
properties:
productTypes:
type: array
items:
$ref: '#/definitions/ProductType'
description: the list of available products for a user/contract.
ValueOption:
type: object
properties:
allowedValue:
type: array
items:
type: string
alertThreshold:
type: string
proposalThreshold:
type: string
defaultValue:
type: string
minValue:
type: string
maxValue:
type: string
description: TODO voir doc progserver
OnePlanAdvancedOptions:
type: object
properties:
acquisitionPeriod:
$ref: '#/definitions/DateRange'
maxCloudCover:
$ref: '#/definitions/ValueOption'
maxIncidenceAngle:
$ref: '#/definitions/ValueOption'
acquisitionMode:
$ref: '#/definitions/ValueOption'
minBH:
$ref: '#/definitions/ValueOption'
maxBH:
$ref: '#/definitions/ValueOption'
comment:
$ref: '#/definitions/ValueOption'
description: options for Manual OnePlan tasking capacity.
Option:
type: object
properties:
category:
type: string
constraint:
$ref: '#/definitions/Constraint'
label:
type: string
name:
type: string
type:
type: string
values:
type: array
items:
$ref: '#/definitions/OptionListItem'
defaultValue:
type: string
range:
type: array
items:
type: number
format: double
format:
type: string
mandatory:
type: string
description: definition of an expected option. Contains a category defining its location (category=technical_product -> optionsPerProductType, category=item_properties -> properties of WorkOrderItem), a constraint defining its validity, a name that can be used in another option's constraint, a type (double, list, periods or string), the expected values it type=list, the range if type=double, the expected format of the string/periods and if the option is mandatory.
example: {
category: "technical_product",
defaultValue: "ortho",
label: "PROCESSING_LEVEL",
mandatory: "true",
name: "processing_level",
type: "list",
values:
[
{
id: "ortho",
label: "Ortho"
},
{
id: "projected",
label: "Projected"
},
{
id: "primary",
label: "Primary"
}
]
}
OptionListItem:
type: object
properties:
id:
type: string
label:
type: string
description: the definition of a possible value for an option. Only the id must be used in constraints (see Constraint) or options selection (see OptionsPerProductType).
example: {
id: "primary",
label: "Processing Level PRIMARY"
}
Constraint:
type: object
properties:
reject:
type: boolean
default: false
filter:
type: string
description: a query filter to be applied on the resulting option domain object
description: the constraint to be applied on the option. Contains two fields, reject (boolean) and filter (string) a query filter to be applied on the resulting option domain object)
example: {
reject: true,
filter: "processing_level:primary"
}
Feasibility:
type: object
properties:
classification:
type: string
description: the feasibility information for tasking capacity. Classification possible values are EASY and CHALLENGING.
Contract:
type: object
properties:
contractId:
type: string
description: contract identifier
name:
type: string
description: contract name
tradeAgreementUrl:
type: string
creditRemaining:
type: string
currency:
$ref: '#/definitions/Currency'
language:
type: string
format: ISO 639-1
description: defines a contract for a user. Contains an URL displaying the trade agreement, the remaining credit on this contract, and commercial data.
WorkOrderItem:
type: object
properties:
comments:
type: string
datastripIds:
type: array
items:
type: string
aoiId:
type: integer
format: int32
description: identifier of area Of Interest
productTypeId:
type: string
properties:
type: array
items:
$ref: '#/definitions/Property'
description: defines an item in a WorkOrder. Contains the datastrips ID for an archive item, the AOI identifier for which the item has been selected, the product type of the item and the item properties. Expected properties can be retrieved from the Get Options service.
OpticalParameters:
type: object
properties:
acquisitionMode:
type: string
enum:
- MONO
- STEREO
- TRISTEREO
maxCloudCover:
description: maximum cloud coverage percentage
type: number
format: float
maxIncidenceAngle:
type: number
format: float
description: request to get the capacities of the ProgServer for potential tasking.
# SarParameters:
# type: object
# properties:
# eleVationAngleMin:
# type: number
# format: float
# eleVationAngleMax:
# type: number
# format: float
# orbitDirection:
# type: string
# enum:
# - ASCENDING
# - DESCENDING
# - BOTH
# instrumentMode:
# type: string
# enum:
# - ST
# - HS
# - SL
# - SM
# - SC
# - WS
# description: ST=STARING SPOT LIGHT;HS=HIGH RESOLUTION SPOT LIGHT;SL=SPOT LIGHT;SM=STRIP MAP;SC=SCAN SAR;WS=WIDE SCAN
# polarizationMode:
# type: string
# enum:
# - HH
# - VV
# - VH
# - HV
# - HHVV
# - HHHV
# - VVVH
# antennaLookDirection:
# type: string
# enum:
# - R
# description: R = RIGHT
# bandWidth:
# type: string
# enum:
# - 150
# - 300
TaskingCapacityRequest:
type: object
properties:
contractId:
type: string
progTypeNames:
type: array
items:
$ref: '#/definitions/ProgTypeName'
missions: