-
Notifications
You must be signed in to change notification settings - Fork 5k
/
weather.json
2487 lines (2487 loc) · 96.8 KB
/
weather.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
{
"swagger": "2.0",
"info": {
"title": "Azure Maps Weather Service",
"version": "1.0"
},
"host": "atlas.microsoft.com",
"schemes": [
"https"
],
"consumes": [],
"produces": [
"application/json"
],
"securityDefinitions": {
"AADToken": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.",
"scopes": {
"https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default"
}
},
"SharedKey": {
"type": "apiKey",
"description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.",
"name": "subscription-key",
"in": "query"
},
"SasToken": {
"type": "apiKey",
"description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.",
"name": "SAS Token",
"in": "header"
}
},
"security": [
{
"AADToken": [
"https://atlas.microsoft.com/.default"
]
},
{
"SharedKey": []
},
{
"SasToken": []
}
],
"responses": {},
"parameters": {
"ApiVersion": {
"name": "api-version",
"description": "Version number of Azure Maps API.",
"type": "string",
"in": "query",
"required": true,
"default": "1.0",
"x-ms-parameter-location": "client"
},
"WeatherDataUnit": {
"name": "unit",
"description": "Specifies to return the data in either metric units or imperial units. Default value is metric.",
"in": "query",
"type": "string",
"enum": [
"metric",
"imperial"
],
"x-ms-enum": {
"name": "WeatherDataUnit",
"modelAsString": true,
"values": [
{
"value": "metric",
"description": "Return data in metric units. Some example units of metric system are Celsius and kilometer."
},
{
"value": "imperial",
"description": "Return data in imperial units. Some example units of imperial system are Fahrenheit and mile."
}
]
},
"x-ms-parameter-location": "method"
}
},
"paths": {
"/weather/forecast/hourly/{format}": {
"get": {
"description": "**Get Hourly Forecast**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nRequest detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and 240 hours (10 days) for the given the given coordinate location. The API returns details such as temperature, humidity, wind, precipitation, and ultraviolet (UV) index.\n\nIn S0 you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). In S1 you can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days).",
"operationId": "Weather_GetHourlyForecast",
"x-ms-examples": {
"Successfully retrieve detailed weather forecast by the hour": {
"$ref": "./examples/GetHourlyForecast.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
},
{
"name": "query",
"x-ms-client-name": "coordinates",
"in": "query",
"description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".",
"required": true,
"x-ms-parameter-location": "method",
"type": "array",
"collectionFormat": "csv",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number",
"format": "double"
}
},
{
"$ref": "#/parameters/WeatherDataUnit"
},
{
"name": "duration",
"description": "Time frame of the returned weather forecast. By default, the forecast data for next hour will be returned. Available values are\n * `1` - Return forecast data for the next hour. Default value.\n * `12` - Return hourly forecast for next 12 hours.\n * `24` - Return hourly forecast for next 24 hours.\n * `72` - Return hourly forecast for next 72 hours (3 days).\n * `120` - Return hourly forecast for next 120 hours (5 days). Only available in S1 SKU. \n * `240` - Return hourly forecast for next 240 hours (10 days). Only available in S1 SKU.",
"in": "query",
"type": "integer"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/Language"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/HourlyForecastResponse"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/weather/forecast/minute/{format}": {
"get": {
"description": "**Get Minute Forecast**\n \n \n**Applies to**: S1 pricing tier.\n\n\nGet Minute Forecast service returns minute-by-minute forecasts for a given location for the next 120 minutes. Users can request weather forecasts in the interval of 1, 5 and 15 minutes. The response will include details such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation intensity value (dBZ).",
"operationId": "Weather_GetMinuteForecast",
"x-ms-examples": {
"Successfully retrieve minute-by-minute forecasts for a given location": {
"$ref": "./examples/GetMinuteForecast.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
},
{
"name": "query",
"x-ms-client-name": "coordinates",
"in": "query",
"description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".",
"required": true,
"x-ms-parameter-location": "method",
"type": "array",
"collectionFormat": "csv",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number",
"format": "double"
}
},
{
"name": "interval",
"description": "Specifies time interval in minutes for the returned weather forecast. Supported values are\n * `1` - Retrieve forecast for 1-minute intervals. Returned by default.\n * `5` - Retrieve forecasts for 5-minute intervals.\n * `15` - Retrieve forecasts for 15-minute intervals.",
"in": "query",
"type": "integer"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/Language"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MinuteForecastResponse"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/weather/forecast/quarterDay/{format}": {
"get": {
"description": "**Get Quarter-Day Forecast**\n \n \n**Applies to**: S0 and S1 pricing tiers.\n\n\nService returns detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details such as temperature, humidity, wind, precipitation, and UV index are returned.",
"operationId": "Weather_GetQuarterDayForecast",
"x-ms-examples": {
"Successfully retrieve detailed weather forecast by a given location": {
"$ref": "./examples/GetQuarterDayForecast.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
},
{
"name": "query",
"x-ms-client-name": "coordinates",
"in": "query",
"description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".",
"required": true,
"x-ms-parameter-location": "method",
"type": "array",
"collectionFormat": "csv",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number",
"format": "double"
}
},
{
"$ref": "#/parameters/WeatherDataUnit"
},
{
"name": "duration",
"description": "Specifies for how many days the quester-day forecast responses are returned. Supported values are:\n * `1` - Return forecast data for the next day. Returned by default.\n * `5` - Return forecast data for the next 5 days.\n * `10` - Return forecast data for next 10 days.\n * `15` - Return forecast data for the next 15 days.",
"in": "query",
"type": "integer"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/Language"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/QuarterDayForecastResponse"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/weather/currentConditions/{format}": {
"get": {
"description": "**Get Current Conditions**\n \n \n**Applies to**: S0 and S1 pricing tiers.\n\n\nGet Current Conditions service returns detailed current weather conditions such as precipitation, temperature and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular location can be retrieved. The basic information returned with the response include details such as observation date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and temperature. Additional details such as RealFeel™ Temperature and UV index are also returned.",
"operationId": "Weather_GetCurrentConditions",
"x-ms-examples": {
"Successfully retrieve detailed current weather conditions for a given coordinate location": {
"$ref": "./examples/GetCurrentConditions.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
},
{
"name": "query",
"x-ms-client-name": "coordinates",
"in": "query",
"description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".",
"required": true,
"x-ms-parameter-location": "method",
"type": "array",
"collectionFormat": "csv",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number",
"format": "double"
}
},
{
"$ref": "#/parameters/WeatherDataUnit"
},
{
"name": "details",
"description": "Return full details for the current conditions. Available values are\n * `true` - Returns full details. By default all details are returned.\n * `false` - Returns a truncated version of the current condition data, which includes observation date time, weather phrase, icon code, precipitation indicator flag, and temperature.",
"in": "query",
"type": "string"
},
{
"name": "duration",
"description": "Time frame of the returned weather conditions. By default, the most current weather conditions will be returned. Default value is 0. Supported values are:\n * `0` - Return the most current weather conditions.\n * `6` - Return weather conditions from past 6 hours.\n * `24` - Return weather conditions from past 24 hours.",
"in": "query",
"type": "integer"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/Language"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CurrentConditionsResponse"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/weather/forecast/daily/{format}": {
"get": {
"description": "**Get Daily Forecast**\n \n \n**Applies to**: S0 and S1 pricing tiers.\n\n\nThe service returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, 25, or 45 days for a given coordinate location. The response include details such as temperature, wind, precipitation, air quality, and UV index.\n\nIn S0 you can request daily forecast for the next 1, 5, 10, and 15 days. In S1 you can also request daily forecast for the next 25 days, and 45 days.",
"operationId": "Weather_GetDailyForecast",
"x-ms-examples": {
"Successfully retrieve detailed daily weather forecast for a given coordinate location": {
"$ref": "./examples/GetDailyForecast.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
},
{
"name": "query",
"x-ms-client-name": "coordinates",
"in": "query",
"description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".",
"required": true,
"x-ms-parameter-location": "method",
"type": "array",
"collectionFormat": "csv",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number",
"format": "double"
}
},
{
"$ref": "#/parameters/WeatherDataUnit"
},
{
"name": "duration",
"description": "Specifies for how many days the daily forecast responses are returned. Available values are\n * `1` - Return forecast data for the next day. Returned by default.\n * `5` - Return forecast data for the next 5 days.\n * `10` - Return forecast data for the next 10 days.\n * `25` - Return forecast data for the next 25 days. Only available in S1 SKU.\n * `45` - Return forecast data for the next 45 days. Only available in S1 SKU.",
"in": "query",
"type": "integer"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/Language"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DailyForecastResponse"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/weather/route/{format}": {
"get": {
"description": "**Get Weather along route**\n \n \n **Applies to**: S1 pricing tier.\n\n Weather along a route API returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, weather hazard assessments, and notifications along a route described as a sequence of waypoints. \n This includes a list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might be used to paint each portion of a route according to how safe it is for the driver. When submitting the waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. Data is updated every five minutes. \n \n The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows you to first request a route between an origin and a destination and use that as an input for Weather Along Route endpoint.\n \n In addition, the service supports scenarios to generate weather notifications for waypoints that experience an increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing the end product to display a heavy rain notification before the driver reaches that waypoint. \n The trigger for when to display the notification for a waypoint could be based, for example, on a [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the waypoint.\n\n The API covers all regions of the planet except latitudes above Greenland and Antarctica.",
"operationId": "Weather_GetWeatherAlongRoute",
"x-ms-examples": {
"Successfully retrieve detailed weather casts along a route described as a sequence of waypoints": {
"$ref": "./examples/GetWeatherAlongRoute.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
},
{
"name": "query",
"description": "Coordinates through which the route is calculated, separated by colon (:) and entered in chronological order. A minimum of two waypoints is required. A single API call may contain up to 60 waypoints. \nA waypoint indicates location, ETA, and optional heading: latitude,longitude,ETA,heading, where\n * `Latitude` - Latitude coordinate in decimal degrees.\n * `Longitude` - Longitude coordinate in decimal degrees.\n * `ETA (estimated time of arrival)` - The number of minutes from the present time that it will take for the vehicle to reach the waypoint. Allowed range is from 0.0 to 120.0 minutes.\n * `Heading` - An optional value indicating the vehicle heading as it passes the waypoint. Expressed in clockwise degrees relative to true north. This is issued to calculate sun glare as a driving hazard. Allowed range is from 0.0 to 360.0 degrees. If not provided, a heading will automatically be derived based on the position of neighboring waypoints.\n\nIt is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. This way a more accurate assessment can be provided for the trip and prevent isolated events not being captured between waypoints. Information can and should be updated along the route (especially for trips greater than 2 hours) to continuously pull new waypoints moving forward, but also to ensure that forecast information for content such as precipitation type and intensity is accurate as storms develop and dissipate over time.",
"in": "query",
"type": "string",
"required": true
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/Language"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WeatherAlongRouteResponse"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/weather/severe/alerts/{format}": {
"get": {
"description": "**Get Severe Weather Alerts**\n\n**Applies to**: S0 and S1 pricing tiers.\n\nSevere weather phenomenon can significantly impact our everyday life and business operations. For example, severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of refrigerated food products. Azure Maps Severe Weather Alerts API returns the severe weather alerts that are available worldwide from both official Government Meteorological Agencies and leading global to regional weather alert providers. The service can return details such as alert type, category, level and detailed description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, heat waves or forest fires.",
"operationId": "Weather_GetSevereWeatherAlerts",
"x-ms-examples": {
"Successfully retrieve severe weather alerts": {
"$ref": "./examples/GetSevereWeatherAlerts.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
},
{
"name": "query",
"x-ms-client-name": "coordinates",
"in": "query",
"description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".",
"required": true,
"x-ms-parameter-location": "method",
"type": "array",
"collectionFormat": "csv",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number",
"format": "double"
}
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/Language"
},
{
"name": "details",
"description": "Return full details for the severe weather alerts. Available values are\n * `true` - Returns full details. By default all details are returned.\n * `false` - Returns a truncated version of the alerts data, which excludes the area-specific full description of alert details (`alertDetails`).",
"in": "query",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK,",
"schema": {
"$ref": "#/definitions/SevereWeatherAlertsResponse"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/weather/indices/daily/{format}": {
"get": {
"description": "**Get Daily Indices**\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThere may be times when you want to know if the weather conditions are optimal for a specific activity, for example, for outdoor construction, indoor activities, running or farming including soil moisture information. Azure Maps Indices API returns index values that will guide end users to plan future activities. For example, a health mobile application can notify users that today is good weather for running or for other outdoors activities like for playing golf, and retail stores can optimize their digital marketing campaigns based on predicted index values. The service returns in daily indices values for current and next 5, 10 and 15 days starting from current day.",
"operationId": "Weather_GetDailyIndices",
"x-ms-examples": {
"Successfully retrieve daily indices values from current day": {
"$ref": "./examples/GetDailyIndices.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
},
{
"name": "query",
"x-ms-client-name": "coordinates",
"in": "query",
"description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".",
"required": true,
"x-ms-parameter-location": "method",
"type": "array",
"collectionFormat": "csv",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number",
"format": "double"
}
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/Language"
},
{
"name": "duration",
"description": "Specifies for how many days the daily indices are returned. By default, the indices data for the current day will be returned. When requesting future indices data, the current day is included in the response as day 1. Available values are\n * `1` - Return daily index data for the current day. Default value.\n * `5` - Return 5 days of daily index data starting from the current day.\n * `10` - Return 10 days of daily index data starting from the current day.\n * `15` - Return 15 days of daily index data starting from the current day.",
"in": "query",
"type": "integer"
},
{
"name": "indexId",
"description": "Numeric index identifier that can be used for restricting returned results to the corresponding index type. Cannot be paired with `indexGroupId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported indices.",
"in": "query",
"type": "integer"
},
{
"name": "indexGroupId",
"description": "Numeric index group identifier that can be used for restricting returned results to the corresponding subset of indices (index group). Cannot be paired with `indexId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index groups.",
"in": "query",
"type": "integer"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DailyIndicesResponse"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
}
},
"definitions": {
"IconCode": {
"type": "integer",
"format": "int32",
"description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details.",
"enum": [
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
],
"x-ms-enum": {
"name": "IconCode",
"modelAsString": true,
"values": [
{
"value": 1,
"name": "Sunny",
"description": "Sunny"
},
{
"value": 2,
"name": "MostlySunny",
"description": "Mostly Sunny"
},
{
"value": 3,
"name": "PartlySunny",
"description": "Partly Sunny"
},
{
"value": 4,
"name": "IntermittentClouds",
"description": "Intermittent Clouds"
},
{
"value": 5,
"name": "HazySunshine",
"description": "Hazy Sunshine"
},
{
"value": 6,
"name": "MostlyCloudy",
"description": "Mostly Cloudy"
},
{
"value": 7,
"name": "Cloudy",
"description": "Cloudy"
},
{
"value": 8,
"name": "Dreary",
"description": "Dreary (Overcast)"
},
{
"value": 11,
"name": "Fog",
"description": "Fog"
},
{
"value": 12,
"name": "Showers",
"description": "Showers"
},
{
"value": 13,
"name": "MostlyCloudyWithShowers",
"description": "Mostly Cloudy with Showers"
},
{
"value": 14,
"name": "PartlySunnyWithShowers",
"description": "Partly Sunny with Showers"
},
{
"value": 15,
"name": "Thunderstorms",
"description": "Thunderstorms"
},
{
"value": 16,
"name": "MostlyCloudyWithThunderstorms",
"description": "Mostly Cloudy with Thunderstorms"
},
{
"value": 17,
"name": "PartlySunnyWithThunderstorms",
"description": "Partly Sunny with Thunderstorms"
},
{
"value": 18,
"name": "Rain",
"description": "Rain"
},
{
"value": 19,
"name": "Flurries",
"description": "Flurries"
},
{
"value": 20,
"name": "MostlyCloudyWithFlurries",
"description": "Mostly Cloudy with Flurries"
},
{
"value": 21,
"name": "PartlySunnyWithFlurries",
"description": "Partly Sunny with Flurries"
},
{
"value": 22,
"name": "Snow",
"description": "Snow"
},
{
"value": 23,
"name": "MostlyCloudyWithSnow",
"description": "Mostly Cloudy with Snow"
},
{
"value": 24,
"name": "Ice",
"description": "Ice"
},
{
"value": 25,
"name": "Sleet",
"description": "Sleet"
},
{
"value": 26,
"name": "FreezingRain",
"description": "Freezing Rain"
},
{
"value": 29,
"name": "RainAndSnow",
"description": "Rain and Snow"
},
{
"value": 30,
"name": "Hot",
"description": "Hot"
},
{
"value": 31,
"name": "Cold",
"description": "Cold"
},
{
"value": 32,
"name": "Windy",
"description": "Windy"
},
{
"value": 33,
"name": "Clear",
"description": "Clear"
},
{
"value": 34,
"name": "Mostly Clear",
"description": "Mostly Clear"
},
{
"value": 35,
"name": "Partly Cloudy",
"description": "Partly Cloudy"
},
{
"value": 36,
"name": "IntermittentCloudsNight",
"description": "Intermittent Clouds (Night)"
},
{
"value": 37,
"name": "HazyMoonlight",
"description": "Hazy Moonlight"
},
{
"value": 38,
"name": "MostlyCloudyNight",
"description": "Mostly Cloudy (Night)"
},
{
"value": 39,
"name": "PartlyCloudyWithShowers",
"description": "Partly Cloudy with Showers"
},
{
"value": 40,
"name": "MostlyCloudyWithShowersNight",
"description": "Mostly Cloudy with Showers (Night)"
},
{
"value": 41,
"name": "Partly Cloudy with Thunderstorms",
"description": "Partly Cloudy with Thunderstorms"
},
{
"value": 42,
"name": "MostlyCloudyWithThunderstormsNight",
"description": "Mostly Cloudy with Thunderstorms (Night)"
},
{
"value": 43,
"name": "MostlyCloudyWithFlurriesNight",
"description": "Mostly Cloudy with Flurries (Night)"
},
{
"value": 44,
"name": "MostlyCloudyWithSnowNight",
"description": "Mostly Cloudy with Snow (Night)"
}
]
}
},
"UnitType": {
"type": "integer",
"format": "int32",
"description": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details.",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
31
],
"x-ms-enum": {
"name": "UnitType",
"modelAsString": true,
"values": [
{
"value": 0,
"name": "Feet",
"description": "feet"
},
{
"value": 1,
"name": "Inches",
"description": "inches"
},
{
"value": 2,
"name": "Miles",
"description": "miles"
},
{
"value": 3,
"name": "Millimeter",
"description": "millimeter"
},
{
"value": 4,
"name": "Centimeter",
"description": "centimeter"
},
{
"value": 5,
"name": "Meter",
"description": "meter"
},
{
"value": 6,
"name": "Kilometer",
"description": "kilometer"
},
{
"value": 7,
"name": "KilometersPerHour",
"description": "kilometersPerHour"
},
{
"value": 8,
"name": "Knots",
"description": "knots"
},
{
"value": 9,
"name": "MilesPerHour",
"description": "milesPerHour"
},
{
"value": 10,
"name": "MetersPerSecond",
"description": "metersPerSecond"
},
{
"value": 11,
"name": "HectoPascals",
"description": "hectoPascals"
},
{
"value": 12,
"name": "InchesOfMercury",
"description": "inchesOfMercury"
},
{
"value": 13,
"name": "KiloPascals",
"description": "kiloPascals"
},
{
"value": 14,
"name": "Millibars",
"description": "millibars"
},
{
"value": 15,
"name": "MillimetersOfMercury",
"description": "millimetersOfMercury"
},
{
"value": 16,
"name": "PoundsPerSquareInch",
"description": "poundsPerSquareInch"
},
{
"value": 17,
"name": "Celsius",
"description": "celsius"
},
{
"value": 18,
"name": "Fahrenheit",
"description": "fahrenheit"
},
{
"value": 19,
"name": "Kelvin",
"description": "kelvin"
},
{
"value": 20,
"name": "Percent",
"description": "percent"
},
{
"value": 21,
"name": "Float",
"description": "float"
},
{
"value": 22,
"name": "Integer",
"description": "integer"
},
{
"value": 31,
"name": "MicrogramsPerCubicMeterOfAir",
"description": "MicrogramsPerCubicMeterOfAir"
}
]
}
},
"PrecipitationType": {
"type": "string",
"description": "Specifies the type of precipitation (\"Rain\" \"Snow\" \"Ice\" or \"Mix\"). If dbz is zero, precipitationType is not present in the response.",
"enum": [
"Rain",
"Snow",
"Ice",
"Mix"
],
"x-ms-enum": {
"name": "PrecipitationType",
"modelAsString": true,
"values": [
{
"value": "Rain",
"description": "Rain"
},