diff --git a/custom-words.txt b/custom-words.txt index ac38338b9051..61ca52145346 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2429,6 +2429,8 @@ Ctlr vcenters Mwarev pmem +actuals +Actuals rawphysical rawvirtual sesparse diff --git a/specification/maps/data-plane/Weather/readme.md b/specification/maps/data-plane/Weather/readme.md index bdcee5b6b223..05a4450b5941 100644 --- a/specification/maps/data-plane/Weather/readme.md +++ b/specification/maps/data-plane/Weather/readme.md @@ -27,7 +27,7 @@ These are the global settings for Weather Client. ``` yaml title: WeatherClient openapi-type: data-plane -tag: 1.0-preview +tag: 1.1 # at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718) add-credentials: true credential-default-policy-type: BearerTokenCredentialPolicy @@ -35,6 +35,15 @@ credential-scopes: https://atlas.microsoft.com/.default ``` +### Tag: 1.1 + +These settings apply only when `--tag=1.1` is specified on the command line. + +``` yaml $(tag) == '1.1' +input-file: + - stable/1.1/weather.json +``` + ### Tag: 1.0-preview These settings apply only when `--tag=1.0-preview` is specified on the command line. diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetActiveStorms.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetActiveStorms.json new file mode 100644 index 000000000000..867dce24705b --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetActiveStorms.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "year": "2021", + "basinId": "EP", + "name": "Hilda", + "isActive": true, + "isSubtropical": false, + "govId": 8 + }, + { + "year": "2021", + "basinId": "EP", + "name": "TD 9E", + "isActive": true, + "isSubtropical": false, + "govId": 9 + }, + { + "year": "2021", + "basinId": "NP", + "name": "TWELVE", + "isActive": true, + "isSubtropical": false, + "govId": 12 + }, + { + "year": "2021", + "basinId": "NP", + "name": "LUPIT", + "isActive": true, + "isSubtropical": false, + "govId": 13 + }, + { + "year": "2021", + "basinId": "NP", + "name": "FOURTEEN", + "isActive": true, + "isSubtropical": false, + "govId": 14 + }, + { + "year": "2021", + "basinId": "NP", + "name": "FIFTEEN", + "isActive": true, + "isSubtropical": false, + "govId": 15 + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetCurrentAirQuality.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetCurrentAirQuality.json new file mode 100644 index 000000000000..585c0e5a8ba6 --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetCurrentAirQuality.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "query": "47.632346,-122.13887" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "dateTime": "2021-07-19T02:00:00+00:00", + "index": 21.6, + "globalIndex": 22.1, + "dominantPollutant": "Ozone", + "category": "Fair", + "categoryColor": "#FFC300", + "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure.", + "pollutants": [ + { + "type": "NO2", + "name": "Nitrogen Dioxide", + "index": 6.7, + "globalIndex": 6.7, + "concentration": { + "value": 13.4, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "O3", + "name": "Ozone", + "index": 21.6, + "globalIndex": 22.1, + "concentration": { + "value": 53.5, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM10", + "name": "Particulate Matter 10", + "index": 11.3, + "globalIndex": 12.2, + "concentration": { + "value": 12.2, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM2.5", + "name": "Particulate Matter 2.5", + "index": 13.5, + "globalIndex": 6.5, + "concentration": { + "value": 3.2, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "CO", + "name": "Carbon Monoxide", + "index": 1.2, + "globalIndex": 0.6, + "concentration": { + "value": 118.4, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "SO2", + "name": "Sulfur Dioxide", + "index": 0.6, + "globalIndex": 1.1, + "concentration": { + "value": 1.1, + "unit": "µg/m³", + "unitType": 31 + } + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetCurrentConditions.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetCurrentConditions.json new file mode 100644 index 000000000000..98c2f89394f2 --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetCurrentConditions.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "query": "47.641268,-122.125679" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "dateTime": "2019-11-14T15:08:00-08:00", + "phrase": "Cloudy", + "iconCode": 7, + "hasPrecipitation": false, + "isDayTime": true, + "temperature": { + "value": 13.7, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 13.6, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperatureShade": { + "value": 13.6, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 75, + "dewPoint": { + "value": 9.2, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 315, + "localizedDescription": "NW" + }, + "speed": { + "value": 3.6, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 4.9, + "unit": "km/h", + "unitType": 7 + } + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "visibility": { + "value": 8, + "unit": "km", + "unitType": 6 + }, + "obstructionsToVisibility": "", + "cloudCover": 95, + "ceiling": { + "value": 4359, + "unit": "m", + "unitType": 5 + }, + "pressure": { + "value": 1014.9, + "unit": "mb", + "unitType": 14 + }, + "pressureTendency": { + "localizedDescription": "Steady", + "code": "S" + }, + "pastTwentyFourHourTemperatureDeparture": { + "value": 1.8, + "unit": "C", + "unitType": 17 + }, + "apparentTemperature": { + "value": 16.1, + "unit": "C", + "unitType": 17 + }, + "windChillTemperature": { + "value": 13.9, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 11.4, + "unit": "C", + "unitType": 17 + }, + "precipitationSummary": { + "pastHour": { + "value": 0.5, + "unit": "mm", + "unitType": 3 + }, + "pastThreeHours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "pastSixHours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "pastNineHours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "pastTwelveHours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "pastEighteenHours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "pastTwentyFourHours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + } + }, + "temperatureSummary": { + "pastSixHours": { + "minimum": { + "value": 8.3, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 13.7, + "unit": "C", + "unitType": 17 + } + }, + "pastTwelveHours": { + "minimum": { + "value": 5.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 13.7, + "unit": "C", + "unitType": 17 + } + }, + "pastTwentyFourHours": { + "minimum": { + "value": 5.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 13.7, + "unit": "C", + "unitType": 17 + } + } + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyAirQuality.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyAirQuality.json new file mode 100644 index 000000000000..d29b245313e3 --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyAirQuality.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "query": "47.632346,-122.13887", + "duration": 3 + }, + "responses": { + "200": { + "body": { + "results": [ + { + "dateTime": "2021-07-18T07:00:00+00:00", + "index": 35.1, + "globalIndex": 42.2, + "dominantPollutant": "Ozone", + "category": "Fair", + "categoryColor": "#FFC300", + "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure." + }, + { + "dateTime": "2021-07-19T07:00:00+00:00", + "index": 31.6, + "globalIndex": 37.0, + "dominantPollutant": "Ozone", + "category": "Fair", + "categoryColor": "#FFC300", + "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure." + }, + { + "dateTime": "2021-07-20T07:00:00+00:00", + "index": 33.6, + "globalIndex": 40.0, + "dominantPollutant": "Ozone", + "category": "Fair", + "categoryColor": "#FFC300", + "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure." + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyForecast.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyForecast.json new file mode 100644 index 000000000000..500e7b6fae25 --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyForecast.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "query": "62.6490341,30.0734812", + "duration": 5 + }, + "responses": { + "200": { + "body": { + "summary": { + "startDate": "2019-11-17T09:00:00-08:00", + "endDate": "2019-11-17T15:00:00-08:00", + "severity": 5, + "phrase": "Rain Sunday evening", + "category": "rain" + }, + "forecasts": [ + { + "date": "2019-11-13T21:00:00-08:00", + "temperature": { + "minimum": { + "value": 0.8, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 5.3, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": -3.4, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 1.3, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperatureShade": { + "minimum": { + "value": -3.4, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 1.6, + "unit": "C", + "unitType": 17 + } + }, + "hoursOfSun": 1.1, + "degreeDaySummary": { + "heating": { + "value": 15, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0, + "unit": "C", + "unitType": 17 + } + }, + "airAndPollen": [ + { + "name": "AirQuality", + "value": 0, + "category": "Good", + "categoryValue": 1, + "type": "Ozone" + }, + { + "name": "Grass", + "value": 0, + "category": "Low", + "categoryValue": 1 + }, + { + "name": "Mold", + "value": 0, + "category": "Low", + "categoryValue": 1 + }, + { + "name": "Ragweed", + "value": 0, + "category": "Low", + "categoryValue": 1 + }, + { + "name": "Tree", + "value": 0, + "category": "Low", + "categoryValue": 1 + }, + { + "name": "UVIndex", + "value": 0, + "category": "Low", + "categoryValue": 1 + } + ], + "day": { + "iconCode": 12, + "iconPhrase": "Showers", + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "shortPhrase": "Cloudy with a few showers", + "longPhrase": "Cloudy with a couple of showers, mainly later", + "precipitationProbability": 75, + "thunderstormProbability": 20, + "rainProbability": 75, + "snowProbability": 40, + "iceProbability": 0, + "wind": { + "direction": { + "degrees": 160, + "localizedDescription": "SSE" + }, + "speed": { + "value": 16.7, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 160, + "localizedDescription": "SSE" + }, + "speed": { + "value": 48.2, + "unit": "km/h", + "unitType": 7 + } + }, + "totalLiquid": { + "value": 6.1, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 6.1, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "hoursOfPrecipitation": 3.5, + "hoursOfRain": 3.5, + "hoursOfSnow": 0, + "hoursOfIce": 0, + "cloudCover": 100 + }, + "night": { + "iconCode": 12, + "iconPhrase": "Showers", + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "shortPhrase": "Breezy early; cloudy", + "longPhrase": "Breezy this evening; otherwise, low clouds", + "precipitationProbability": 65, + "thunderstormProbability": 0, + "rainProbability": 64, + "snowProbability": 40, + "iceProbability": 0, + "wind": { + "direction": { + "degrees": 181, + "localizedDescription": "S" + }, + "speed": { + "value": 20.4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 170, + "localizedDescription": "S" + }, + "speed": { + "value": 42.6, + "unit": "km/h", + "unitType": 7 + } + }, + "totalLiquid": { + "value": 4, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 4, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "hoursOfPrecipitation": 2.5, + "hoursOfRain": 2.5, + "hoursOfSnow": 0, + "hoursOfIce": 0, + "cloudCover": 98 + }, + "sources": [ + "AccuWeather" + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyHistoricalActuals.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyHistoricalActuals.json new file mode 100644 index 000000000000..0ac282f918cb --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyHistoricalActuals.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "query": "40.78,-77.89", + "startDate": "2012-01-20", + "endDate": "2012-01-22" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "date": "2012-01-20T00:00:00-04:00", + "temperature": { + "maximum": { + "value": -6.1, + "unit": "C", + "unitType": 17 + }, + "minimum": { + "value": -11.1, + "unit": "C", + "unitType": 17 + }, + "average": { + "value": -8.6, + "unit": "C", + "unitType": 17 + } + }, + "degreeDaySummary": { + "heating": { + "value": 27.0, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0.0, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "value": 10.9, + "unit": "mm", + "unitType": 3 + }, + "snowfall": { + "value": 12.19, + "unit": "cm", + "unitType": 4 + }, + "snowDepth": { + "value": 15.2, + "unit": "cm", + "unitType": 4 + } + }, + { + "date": "2012-01-21T00:00:00-04:00", + "temperature": { + "maximum": { + "value": -1.7, + "unit": "C", + "unitType": 17 + }, + "minimum": { + "value": -8.9, + "unit": "C", + "unitType": 17 + }, + "average": { + "value": -5.3, + "unit": "C", + "unitType": 17 + } + }, + "degreeDaySummary": { + "heating": { + "value": 24.0, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0.0, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "value": 0.0, + "unit": "mm", + "unitType": 3 + }, + "snowfall": { + "value": 0.51, + "unit": "cm", + "unitType": 4 + }, + "snowDepth": { + "value": 12.7, + "unit": "cm", + "unitType": 4 + } + }, + { + "date": "2012-01-22T00:00:00-04:00", + "temperature": { + "maximum": { + "value": 0.0, + "unit": "C", + "unitType": 17 + }, + "minimum": { + "value": -7.2, + "unit": "C", + "unitType": 17 + }, + "average": { + "value": -3.6, + "unit": "C", + "unitType": 17 + } + }, + "degreeDaySummary": { + "heating": { + "value": 22.0, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0.0, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "value": 0.0, + "unit": "mm", + "unitType": 3 + }, + "snowfall": { + "value": 0.0, + "unit": "cm", + "unitType": 4 + }, + "snowDepth": { + "value": 10.2, + "unit": "cm", + "unitType": 4 + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyHistoricalNormals.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyHistoricalNormals.json new file mode 100644 index 000000000000..ff8c6bffb6e0 --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyHistoricalNormals.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "query": "39.952583,-75.165222", + "startDate": "2012-01-20", + "endDate": "2012-01-22" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "date": "2012-01-20T00:00:00-04:00", + "temperature": { + "maximum": { + "value": 4.4, + "unit": "C", + "unitType": 17 + }, + "minimum": { + "value": -3.7, + "unit": "C", + "unitType": 17 + }, + "average": { + "value": 0.4, + "unit": "C", + "unitType": 17 + } + }, + "degreeDaySummary": { + "heating": { + "value": 18.0, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0.0, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "value": 2.5, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2012-01-21T00:00:00-04:00", + "temperature": { + "maximum": { + "value": 4.5, + "unit": "C", + "unitType": 17 + }, + "minimum": { + "value": -3.7, + "unit": "C", + "unitType": 17 + }, + "average": { + "value": 0.4, + "unit": "C", + "unitType": 17 + } + }, + "degreeDaySummary": { + "heating": { + "value": 18.0, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0.0, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "value": 2.5, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2012-01-22T00:00:00-04:00", + "temperature": { + "maximum": { + "value": 4.5, + "unit": "C", + "unitType": 17 + }, + "minimum": { + "value": -3.7, + "unit": "C", + "unitType": 17 + }, + "average": { + "value": 0.4, + "unit": "C", + "unitType": 17 + } + }, + "degreeDaySummary": { + "heating": { + "value": 18.0, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0.0, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "value": 2.3, + "unit": "mm", + "unitType": 3 + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyHistoricalRecords.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyHistoricalRecords.json new file mode 100644 index 000000000000..30546ad89f96 --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyHistoricalRecords.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "query": "39.952583,-75.165222", + "startDate": "2012-01-20", + "endDate": "2012-01-22" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "date": "2012-01-20T00:00:00-04:00", + "temperature": { + "maximum": { + "value": 18.3, + "unit": "C", + "unitType": 17, + "year": 1951 + }, + "minimum": { + "value": -19.4, + "unit": "C", + "unitType": 17, + "year": 1984 + }, + "average": { + "value": -0.6, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "maximum": { + "value": 48.0, + "unit": "mm", + "unitType": 3, + "year": 1978 + } + }, + "snowfall": { + "maximum": { + "value": 12.19, + "unit": "cm", + "unitType": 4, + "year": 1978 + } + } + }, + { + "date": "2012-01-21T00:00:00-04:00", + "temperature": { + "maximum": { + "value": 16.7, + "unit": "C", + "unitType": 17, + "year": 1959 + }, + "minimum": { + "value": -21.1, + "unit": "C", + "unitType": 17, + "year": 1985 + }, + "average": { + "value": -2.2, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "maximum": { + "value": 33.5, + "unit": "mm", + "unitType": 3, + "year": 1979 + } + }, + "snowfall": { + "maximum": { + "value": 34.29, + "unit": "cm", + "unitType": 4, + "year": 2014 + } + } + }, + { + "date": "2012-01-22T00:00:00-04:00", + "temperature": { + "maximum": { + "value": 21.1, + "unit": "C", + "unitType": 17, + "year": 1906 + }, + "minimum": { + "value": -21.7, + "unit": "C", + "unitType": 17, + "year": 1984 + }, + "average": { + "value": -0.3, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "maximum": { + "value": 26.2, + "unit": "mm", + "unitType": 3, + "year": 1987 + } + }, + "snowfall": { + "maximum": { + "value": 22.35, + "unit": "cm", + "unitType": 4, + "year": 1987 + } + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyIndices.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyIndices.json new file mode 100644 index 000000000000..558a54297a5f --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetDailyIndices.json @@ -0,0 +1,206 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "query": "43.84745,-79.37849", + "indexGroupId": 11 + }, + "responses": { + "200": { + "body": { + "results": [ + { + "indexName": "Running Forecast", + "indexId": 1, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.2, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is an excellent day for outdoor running!" + }, + { + "indexName": "Jogging Forecast", + "indexId": 2, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.4, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "Conditions are excellent for jogging outdoors!" + }, + { + "indexName": "Hiking Forecast", + "indexId": 3, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.8, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "Conditions are excellent for hiking!" + }, + { + "indexName": "Bicycling Forecast", + "indexId": 4, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.9, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "Conditions are excellent for bicycling outdoors!" + }, + { + "indexName": "Golf Weather Forecast", + "indexId": 5, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 10.0, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is a great day for golf." + }, + { + "indexName": "Tennis Forecast", + "indexId": 6, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.2, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is an excellent day for playing tennis!" + }, + { + "indexName": "Skateboarding Forecast", + "indexId": 7, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.9, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is an excellent day for skateboarding!" + }, + { + "indexName": "Outdoor Concert Forecast", + "indexId": 8, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.7, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "Conditions are excellent for attending an outdoor concert!" + }, + { + "indexName": "Kite Flying Forecast", + "indexId": 9, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 8.5, + "category": "Very Good", + "categoryValue": 4, + "ascending": true, + "description": "Conditions are very good today for kite-flying." + }, + { + "indexName": "Beach & Pool Forecast", + "indexId": 10, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 8.6, + "category": "Very Good", + "categoryValue": 4, + "ascending": true, + "description": "Conditons will be very good for a visit to the beach or pool." + }, + { + "indexName": "Sailing Forecast", + "indexId": 11, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 8.3, + "category": "Very Good", + "categoryValue": 4, + "ascending": true, + "description": "Conditions will be very good for sailing." + }, + { + "indexName": "Stargazing Forecast", + "indexId": 12, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.5, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is a great night to be stargazing!" + }, + { + "indexName": "Fishing Forecast", + "indexId": 13, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 3.5, + "category": "Fair", + "categoryValue": 2, + "ascending": true, + "description": "Expect only fair conditions for fishing." + }, + { + "indexName": "Ski Weather Forecast", + "indexId": 15, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 0.0, + "category": "Poor", + "categoryValue": 1, + "ascending": true, + "description": "Expect poor conditions for skiing." + }, + { + "indexName": "Mosquito Activity Forecast", + "indexId": 17, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 7.0, + "category": "Very High", + "categoryValue": 4, + "ascending": true, + "description": "The weather is favorable for a very high level of mosquito activity. Plan activities and insect repellents accordingly." + }, + { + "indexName": "Hunting Forecast", + "indexId": 20, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 4.5, + "category": "Fair", + "categoryValue": 2, + "ascending": true, + "description": "Expect only fair conditions for hunting." + }, + { + "indexName": "Outdoor Barbecue", + "indexId": 24, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.8, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is a great day for an outdoor barbecue!" + }, + { + "indexName": "Lawn Mowing Forecast", + "indexId": 28, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.6, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is a great day for lawn mowing!" + }, + { + "indexName": "Outdoor Activity Forecast", + "indexId": 29, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 8.7, + "category": "Very Good", + "categoryValue": 4, + "ascending": true, + "description": "Conditions will be very good for outdoor activities." + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetFullStormSearch.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetFullStormSearch.json new file mode 100644 index 000000000000..eb0259542e30 --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetFullStormSearch.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "year": 2021, + "basinId": "AL", + "govId": 1 + }, + "responses": { + "200": { + "body": { + "results": [ + { + "year": "2021", + "basinId": "AL", + "govId": 1, + "name": "Ana", + "isActive": false, + "isRetired": false, + "isSubtropical": false + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetHourlyAirQuality.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetHourlyAirQuality.json new file mode 100644 index 000000000000..267a9e8ef4ad --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetHourlyAirQuality.json @@ -0,0 +1,940 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "query": "47.632346,-122.138874", + "duration": 12 + }, + "responses": { + "200": { + "body": { + "results": [ + { + "dateTime": "2021-07-19T04:00:00+00:00", + "index": 20.1, + "globalIndex": 19.9, + "dominantPollutant": "Ozone", + "category": "Excellent", + "categoryColor": "#00E39B", + "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.", + "pollutants": [ + { + "type": "NO2", + "name": "Nitrogen Dioxide", + "index": 7.5, + "globalIndex": 7.5, + "concentration": { + "value": 14.9, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "O3", + "name": "Ozone", + "index": 20.1, + "globalIndex": 19.9, + "concentration": { + "value": 49.8, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM10", + "name": "Particulate Matter 10", + "index": 11.6, + "globalIndex": 12.6, + "concentration": { + "value": 12.6, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM2.5", + "name": "Particulate Matter 2.5", + "index": 14.3, + "globalIndex": 6.9, + "concentration": { + "value": 3.4, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "CO", + "name": "Carbon Monoxide", + "index": 1.2, + "globalIndex": 0.6, + "concentration": { + "value": 125.6, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "SO2", + "name": "Sulfur Dioxide", + "index": 0.6, + "globalIndex": 1.2, + "concentration": { + "value": 1.2, + "unit": "µg/m³", + "unitType": 31 + } + } + ] + }, + { + "dateTime": "2021-07-19T05:00:00+00:00", + "index": 19.2, + "globalIndex": 19.1, + "dominantPollutant": "Ozone", + "category": "Excellent", + "categoryColor": "#00E39B", + "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.", + "pollutants": [ + { + "type": "NO2", + "name": "Nitrogen Dioxide", + "index": 7.8, + "globalIndex": 7.7, + "concentration": { + "value": 15.5, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "O3", + "name": "Ozone", + "index": 19.2, + "globalIndex": 19.1, + "concentration": { + "value": 47.6, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM10", + "name": "Particulate Matter 10", + "index": 11.9, + "globalIndex": 12.8, + "concentration": { + "value": 12.8, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM2.5", + "name": "Particulate Matter 2.5", + "index": 14.9, + "globalIndex": 7.1, + "concentration": { + "value": 3.6, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "CO", + "name": "Carbon Monoxide", + "index": 1.4, + "globalIndex": 0.7, + "concentration": { + "value": 143.8, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "SO2", + "name": "Sulfur Dioxide", + "index": 0.7, + "globalIndex": 1.3, + "concentration": { + "value": 1.3, + "unit": "µg/m³", + "unitType": 31 + } + } + ] + }, + { + "dateTime": "2021-07-19T06:00:00+00:00", + "index": 18.3, + "globalIndex": 18.2, + "dominantPollutant": "Ozone", + "category": "Excellent", + "categoryColor": "#00E39B", + "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.", + "pollutants": [ + { + "type": "NO2", + "name": "Nitrogen Dioxide", + "index": 8.0, + "globalIndex": 8.0, + "concentration": { + "value": 16.0, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "O3", + "name": "Ozone", + "index": 18.3, + "globalIndex": 18.2, + "concentration": { + "value": 45.5, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM10", + "name": "Particulate Matter 10", + "index": 12.1, + "globalIndex": 13.1, + "concentration": { + "value": 13.1, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM2.5", + "name": "Particulate Matter 2.5", + "index": 15.4, + "globalIndex": 7.4, + "concentration": { + "value": 3.7, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "CO", + "name": "Carbon Monoxide", + "index": 1.6, + "globalIndex": 0.8, + "concentration": { + "value": 162.1, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "SO2", + "name": "Sulfur Dioxide", + "index": 0.8, + "globalIndex": 1.4, + "concentration": { + "value": 1.4, + "unit": "µg/m³", + "unitType": 31 + } + } + ] + }, + { + "dateTime": "2021-07-19T07:00:00+00:00", + "index": 17.5, + "globalIndex": 17.3, + "dominantPollutant": "Ozone", + "category": "Excellent", + "categoryColor": "#00E39B", + "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.", + "pollutants": [ + { + "type": "NO2", + "name": "Nitrogen Dioxide", + "index": 8.3, + "globalIndex": 8.3, + "concentration": { + "value": 16.6, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "O3", + "name": "Ozone", + "index": 17.5, + "globalIndex": 17.3, + "concentration": { + "value": 43.3, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM10", + "name": "Particulate Matter 10", + "index": 12.4, + "globalIndex": 13.4, + "concentration": { + "value": 13.4, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM2.5", + "name": "Particulate Matter 2.5", + "index": 16.0, + "globalIndex": 7.7, + "concentration": { + "value": 3.8, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "CO", + "name": "Carbon Monoxide", + "index": 1.8, + "globalIndex": 0.9, + "concentration": { + "value": 180.4, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "SO2", + "name": "Sulfur Dioxide", + "index": 0.8, + "globalIndex": 1.5, + "concentration": { + "value": 1.5, + "unit": "µg/m³", + "unitType": 31 + } + } + ] + }, + { + "dateTime": "2021-07-19T08:00:00+00:00", + "index": 16.9, + "globalIndex": 16.8, + "dominantPollutant": "Ozone", + "category": "Excellent", + "categoryColor": "#00E39B", + "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.", + "pollutants": [ + { + "type": "NO2", + "name": "Nitrogen Dioxide", + "index": 8.2, + "globalIndex": 8.2, + "concentration": { + "value": 16.4, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "O3", + "name": "Ozone", + "index": 16.9, + "globalIndex": 16.8, + "concentration": { + "value": 42.0, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM10", + "name": "Particulate Matter 10", + "index": 12.4, + "globalIndex": 13.3, + "concentration": { + "value": 13.3, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM2.5", + "name": "Particulate Matter 2.5", + "index": 15.4, + "globalIndex": 7.4, + "concentration": { + "value": 3.7, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "CO", + "name": "Carbon Monoxide", + "index": 1.8, + "globalIndex": 0.9, + "concentration": { + "value": 180.8, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "SO2", + "name": "Sulfur Dioxide", + "index": 0.9, + "globalIndex": 1.6, + "concentration": { + "value": 1.6, + "unit": "µg/m³", + "unitType": 31 + } + } + ] + }, + { + "dateTime": "2021-07-19T09:00:00+00:00", + "index": 16.4, + "globalIndex": 16.3, + "dominantPollutant": "Ozone", + "category": "Excellent", + "categoryColor": "#00E39B", + "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.", + "pollutants": [ + { + "type": "NO2", + "name": "Nitrogen Dioxide", + "index": 8.1, + "globalIndex": 8.1, + "concentration": { + "value": 16.2, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "O3", + "name": "Ozone", + "index": 16.4, + "globalIndex": 16.3, + "concentration": { + "value": 40.7, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM10", + "name": "Particulate Matter 10", + "index": 12.3, + "globalIndex": 13.3, + "concentration": { + "value": 13.3, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM2.5", + "name": "Particulate Matter 2.5", + "index": 14.8, + "globalIndex": 7.1, + "concentration": { + "value": 3.5, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "CO", + "name": "Carbon Monoxide", + "index": 1.8, + "globalIndex": 0.9, + "concentration": { + "value": 181.3, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "SO2", + "name": "Sulfur Dioxide", + "index": 0.9, + "globalIndex": 1.6, + "concentration": { + "value": 1.6, + "unit": "µg/m³", + "unitType": 31 + } + } + ] + }, + { + "dateTime": "2021-07-19T10:00:00+00:00", + "index": 15.9, + "globalIndex": 15.7, + "dominantPollutant": "Ozone", + "category": "Excellent", + "categoryColor": "#00E39B", + "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.", + "pollutants": [ + { + "type": "NO2", + "name": "Nitrogen Dioxide", + "index": 8.1, + "globalIndex": 8.0, + "concentration": { + "value": 16.1, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "O3", + "name": "Ozone", + "index": 15.9, + "globalIndex": 15.7, + "concentration": { + "value": 39.4, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM10", + "name": "Particulate Matter 10", + "index": 12.3, + "globalIndex": 13.3, + "concentration": { + "value": 13.3, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM2.5", + "name": "Particulate Matter 2.5", + "index": 14.2, + "globalIndex": 6.8, + "concentration": { + "value": 3.4, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "CO", + "name": "Carbon Monoxide", + "index": 1.8, + "globalIndex": 0.9, + "concentration": { + "value": 181.8, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "SO2", + "name": "Sulfur Dioxide", + "index": 0.9, + "globalIndex": 1.6, + "concentration": { + "value": 1.6, + "unit": "µg/m³", + "unitType": 31 + } + } + ] + }, + { + "dateTime": "2021-07-19T11:00:00+00:00", + "index": 15.8, + "globalIndex": 15.7, + "dominantPollutant": "Ozone", + "category": "Excellent", + "categoryColor": "#00E39B", + "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.", + "pollutants": [ + { + "type": "NO2", + "name": "Nitrogen Dioxide", + "index": 8.1, + "globalIndex": 8.1, + "concentration": { + "value": 16.2, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "O3", + "name": "Ozone", + "index": 15.8, + "globalIndex": 15.7, + "concentration": { + "value": 39.2, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM10", + "name": "Particulate Matter 10", + "index": 12.8, + "globalIndex": 13.8, + "concentration": { + "value": 13.8, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM2.5", + "name": "Particulate Matter 2.5", + "index": 14.5, + "globalIndex": 6.9, + "concentration": { + "value": 3.5, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "CO", + "name": "Carbon Monoxide", + "index": 1.8, + "globalIndex": 0.9, + "concentration": { + "value": 179.1, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "SO2", + "name": "Sulfur Dioxide", + "index": 0.8, + "globalIndex": 1.6, + "concentration": { + "value": 1.6, + "unit": "µg/m³", + "unitType": 31 + } + } + ] + }, + { + "dateTime": "2021-07-19T12:00:00+00:00", + "index": 15.7, + "globalIndex": 15.6, + "dominantPollutant": "Ozone", + "category": "Excellent", + "categoryColor": "#00E39B", + "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.", + "pollutants": [ + { + "type": "NO2", + "name": "Nitrogen Dioxide", + "index": 8.2, + "globalIndex": 8.1, + "concentration": { + "value": 16.3, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "O3", + "name": "Ozone", + "index": 15.7, + "globalIndex": 15.6, + "concentration": { + "value": 39.0, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM10", + "name": "Particulate Matter 10", + "index": 13.3, + "globalIndex": 14.3, + "concentration": { + "value": 14.3, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM2.5", + "name": "Particulate Matter 2.5", + "index": 14.7, + "globalIndex": 7.1, + "concentration": { + "value": 3.5, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "CO", + "name": "Carbon Monoxide", + "index": 1.8, + "globalIndex": 0.9, + "concentration": { + "value": 176.4, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "SO2", + "name": "Sulfur Dioxide", + "index": 0.8, + "globalIndex": 1.5, + "concentration": { + "value": 1.5, + "unit": "µg/m³", + "unitType": 31 + } + } + ] + }, + { + "dateTime": "2021-07-19T13:00:00+00:00", + "index": 15.7, + "globalIndex": 15.5, + "dominantPollutant": "Ozone", + "category": "Excellent", + "categoryColor": "#00E39B", + "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.", + "pollutants": [ + { + "type": "NO2", + "name": "Nitrogen Dioxide", + "index": 8.2, + "globalIndex": 8.2, + "concentration": { + "value": 16.4, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "O3", + "name": "Ozone", + "index": 15.7, + "globalIndex": 15.5, + "concentration": { + "value": 38.9, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM10", + "name": "Particulate Matter 10", + "index": 13.7, + "globalIndex": 14.8, + "concentration": { + "value": 14.8, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM2.5", + "name": "Particulate Matter 2.5", + "index": 15.0, + "globalIndex": 7.2, + "concentration": { + "value": 3.6, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "CO", + "name": "Carbon Monoxide", + "index": 1.7, + "globalIndex": 0.9, + "concentration": { + "value": 173.7, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "SO2", + "name": "Sulfur Dioxide", + "index": 0.8, + "globalIndex": 1.5, + "concentration": { + "value": 1.5, + "unit": "µg/m³", + "unitType": 31 + } + } + ] + }, + { + "dateTime": "2021-07-19T14:00:00+00:00", + "index": 18.7, + "globalIndex": 18.6, + "dominantPollutant": "Ozone", + "category": "Excellent", + "categoryColor": "#00E39B", + "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.", + "pollutants": [ + { + "type": "NO2", + "name": "Nitrogen Dioxide", + "index": 7.7, + "globalIndex": 7.7, + "concentration": { + "value": 15.4, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "O3", + "name": "Ozone", + "index": 18.7, + "globalIndex": 18.6, + "concentration": { + "value": 46.5, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM10", + "name": "Particulate Matter 10", + "index": 13.8, + "globalIndex": 14.9, + "concentration": { + "value": 14.9, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM2.5", + "name": "Particulate Matter 2.5", + "index": 14.7, + "globalIndex": 7.1, + "concentration": { + "value": 3.5, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "CO", + "name": "Carbon Monoxide", + "index": 1.6, + "globalIndex": 0.8, + "concentration": { + "value": 165.3, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "SO2", + "name": "Sulfur Dioxide", + "index": 0.8, + "globalIndex": 1.5, + "concentration": { + "value": 1.5, + "unit": "µg/m³", + "unitType": 31 + } + } + ] + }, + { + "dateTime": "2021-07-19T15:00:00+00:00", + "index": 21.8, + "globalIndex": 22.4, + "dominantPollutant": "Ozone", + "category": "Fair", + "categoryColor": "#FFC300", + "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure.", + "pollutants": [ + { + "type": "NO2", + "name": "Nitrogen Dioxide", + "index": 7.3, + "globalIndex": 7.2, + "concentration": { + "value": 14.5, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "O3", + "name": "Ozone", + "index": 21.8, + "globalIndex": 22.4, + "concentration": { + "value": 54.1, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM10", + "name": "Particulate Matter 10", + "index": 13.9, + "globalIndex": 15.0, + "concentration": { + "value": 15.0, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "PM2.5", + "name": "Particulate Matter 2.5", + "index": 14.5, + "globalIndex": 6.9, + "concentration": { + "value": 3.5, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "CO", + "name": "Carbon Monoxide", + "index": 1.6, + "globalIndex": 0.8, + "concentration": { + "value": 157.0, + "unit": "µg/m³", + "unitType": 31 + } + }, + { + "type": "SO2", + "name": "Sulfur Dioxide", + "index": 0.8, + "globalIndex": 1.6, + "concentration": { + "value": 1.6, + "unit": "µg/m³", + "unitType": 31 + } + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetHourlyForecast.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetHourlyForecast.json new file mode 100644 index 000000000000..050ef21fe48b --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetHourlyForecast.json @@ -0,0 +1,1012 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "query": "47.632346,-122.138874", + "duration": 12 + }, + "responses": { + "200": { + "body": { + "forecasts": [ + { + "date": "2019-11-14T16:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": true, + "temperature": { + "value": 13.4, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 14.1, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 10.9, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 8.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 311, + "localizedDescription": "NW" + }, + "speed": { + "value": 3.7, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 5.6, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 72, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 100, + "ceiling": { + "value": 3901, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 39, + "rainProbability": 39, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T17:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 12.5, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 12.8, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 10.2, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7.8, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 281, + "localizedDescription": "W" + }, + "speed": { + "value": 5.6, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 7.4, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 73, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 94, + "ceiling": { + "value": 4054, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 34, + "rainProbability": 34, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T18:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 11.3, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 11.3, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 9.5, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 206, + "localizedDescription": "SSW" + }, + "speed": { + "value": 7.4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 77, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 94, + "ceiling": { + "value": 4176, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 29, + "rainProbability": 29, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T19:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 10.4, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.8, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 169, + "localizedDescription": "S" + }, + "speed": { + "value": 7.4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 11.1, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 79, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 93, + "ceiling": { + "value": 4542, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T20:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 10.1, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 9.2, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.6, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 170, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 11.1, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 80, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 92, + "ceiling": { + "value": 4389, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T21:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 10.1, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 9, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.8, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7.1, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 170, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 82, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 91, + "ceiling": { + "value": 4481, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T22:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.6, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7.2, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 174, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 84, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 92, + "ceiling": { + "value": 4481, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T23:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 175, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 82, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 94, + "ceiling": { + "value": 3688, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-15T00:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 10.1, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.8, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.6, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 176, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 81, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 97, + "ceiling": { + "value": 2926, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-15T01:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.9, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.8, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 177, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 81, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 99, + "ceiling": { + "value": 2164, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 21, + "rainProbability": 21, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-15T02:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.4, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.8, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 172, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 82, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 100, + "ceiling": { + "value": 1737, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 21, + "rainProbability": 21, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-15T03:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.7, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.6, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.4, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 161, + "localizedDescription": "SSE" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 83, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 100, + "ceiling": { + "value": 1311, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 26, + "rainProbability": 26, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetMinuteForecast.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetMinuteForecast.json new file mode 100644 index 000000000000..180649a4e9dd --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetMinuteForecast.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "query": "47.632346,-122.138874", + "interval": 15 + }, + "responses": { + "200": { + "body": { + "summary": { + "briefPhrase60": "Rain ending in 25 min", + "shortPhrase": "Rain ending in 25 min", + "briefPhrase": "Rain ending in 25 min", + "longPhrase": "Rain ending in 25 min", + "iconCode": 12 + }, + "intervalSummaries": [ + { + "startMinute": 0, + "endMinute": 24, + "totalMinutes": 25, + "shortPhrase": "Rain ending in %minute_value min", + "briefPhrase": "Rain ending in %minute_value min", + "longPhrase": "Rain ending in %minute_value min", + "iconCode": 12 + }, + { + "startMinute": 25, + "endMinute": 119, + "totalMinutes": 95, + "shortPhrase": "No precip for %MINUTE_VALUE min", + "briefPhrase": "No precipitation for at least %MINUTE_VALUE min", + "longPhrase": "No precipitation for at least %MINUTE_VALUE min", + "iconCode": 7 + } + ], + "intervals": [ + { + "startTime": "2019-11-14T15:18:00-08:00", + "minute": 0, + "dbz": 23, + "shortPhrase": "Light Rain", + "threshold": "LIGHT", + "color": { + "red": 8, + "green": 98, + "blue": 2, + "hex": "#086202" + }, + "simplifiedColor": { + "red": 35, + "green": 190, + "blue": 39, + "hex": "#23BE27" + }, + "precipitationType": "Rain", + "iconCode": 12, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T15:33:00-08:00", + "minute": 15, + "dbz": 18, + "shortPhrase": "Light Rain", + "threshold": "LIGHT", + "color": { + "red": 32, + "green": 133, + "blue": 9, + "hex": "#208509" + }, + "simplifiedColor": { + "red": 35, + "green": 190, + "blue": 39, + "hex": "#23BE27" + }, + "precipitationType": "Rain", + "iconCode": 12, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T15:48:00-08:00", + "minute": 30, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T16:03:00-08:00", + "minute": 45, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T16:18:00-08:00", + "minute": 60, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T16:33:00-08:00", + "minute": 75, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T16:48:00-08:00", + "minute": 90, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T17:03:00-08:00", + "minute": 105, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetQuarterDayForecast.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetQuarterDayForecast.json new file mode 100644 index 000000000000..207b56061083 --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetQuarterDayForecast.json @@ -0,0 +1,378 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "query": "47.632346,-122.138874", + "duration": 1 + }, + "responses": { + "200": { + "body": { + "forecasts": [ + { + "date": "2019-11-14T00:00:00-08:00", + "effectiveDate": "2019-11-14T07:00:00-08:00", + "quarter": 0, + "iconCode": 12, + "iconPhrase": "Showers", + "phrase": "Mostly cloudy with a shower in spots", + "temperature": { + "minimum": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 11.1, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": 7.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 11.2, + "unit": "C", + "unitType": 17 + } + }, + "dewPoint": { + "value": 7.5, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 90, + "wind": { + "direction": { + "degrees": 206, + "localizedDescription": "SSW" + }, + "speed": { + "value": 3.7, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 192, + "localizedDescription": "SSW" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "visibility": { + "value": 2, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 99, + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "precipitationProbability": 55, + "thunderstormProbability": 20, + "totalLiquid": { + "value": 0.6, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0.6, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T00:00:00-08:00", + "effectiveDate": "2019-11-14T13:00:00-08:00", + "quarter": 1, + "iconCode": 12, + "iconPhrase": "Showers", + "phrase": "Mostly cloudy with a shower in spots", + "temperature": { + "minimum": { + "value": 11.3, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 13.7, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": 11.3, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 14.7, + "unit": "C", + "unitType": 17 + } + }, + "dewPoint": { + "value": 8.4, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 76, + "wind": { + "direction": { + "degrees": 296, + "localizedDescription": "WNW" + }, + "speed": { + "value": 3.7, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 206, + "localizedDescription": "SSW" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "visibility": { + "value": 8, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 96, + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "precipitationProbability": 50, + "thunderstormProbability": 20, + "totalLiquid": { + "value": 0.3, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0.3, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T00:00:00-08:00", + "effectiveDate": "2019-11-14T19:00:00-08:00", + "quarter": 2, + "iconCode": 7, + "iconPhrase": "Cloudy", + "phrase": "Cloudy", + "temperature": { + "minimum": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 10.4, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 9.8, + "unit": "C", + "unitType": 17 + } + }, + "dewPoint": { + "value": 7, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 81, + "wind": { + "direction": { + "degrees": 172, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 174, + "localizedDescription": "S" + }, + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "visibility": { + "value": 10, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 93, + "hasPrecipitation": false, + "precipitationProbability": 25, + "thunderstormProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T00:00:00-08:00", + "effectiveDate": "2019-11-15T01:00:00-08:00", + "quarter": 3, + "iconCode": 12, + "iconPhrase": "Showers", + "phrase": "Cloudy with a little rain", + "temperature": { + "minimum": { + "value": 8.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 9.9, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": 6.2, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 8.6, + "unit": "C", + "unitType": 17 + } + }, + "dewPoint": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 84, + "wind": { + "direction": { + "degrees": 164, + "localizedDescription": "SSE" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 165, + "localizedDescription": "SSE" + }, + "speed": { + "value": 14.8, + "unit": "km/h", + "unitType": 7 + } + }, + "visibility": { + "value": 9, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 99, + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "precipitationProbability": 59, + "thunderstormProbability": 0, + "totalLiquid": { + "value": 1.4, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 1.4, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetSevereWeatherAlerts.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetSevereWeatherAlerts.json new file mode 100644 index 000000000000..138e941341d0 --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetSevereWeatherAlerts.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "query": "48.057,-81.091" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "countryCode": "CA", + "alertId": 242621, + "description": { + "localized": "Heat Warning", + "english": "Heat Warning" + }, + "category": "NON-PRECIPITATION", + "priority": 31, + "source": "Environment Canada", + "sourceId": 3, + "alertAreas": [ + { + "name": "Kirkland Lake - Englehart", + "summary": "Heat Warning in effect until Thursday, 3:16 AM EDT. Source: Environment Canada", + "startTime": "2020-06-29T19:44:00+00:00", + "endTime": "2020-07-02T07:16:03+00:00", + "latestStatus": { + "localized": "Continue", + "english": "Continue" + }, + "alertDetails": "\nA heat event continues through Thursday.\n\nDaytime high temperatures in the low thirties with overnight lows near 18 degrees Celsius are expected to continue until Thursday. Humidex values are expected to reach between 36 and 40 today. Cooler air will move into the region Thursday night. \n\nPlease refer to your public forecast for further details on expected temperatures.\n\nHot and humid air can also bring deteriorating air quality and can result in the air quality health index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nWatch for the effects of heat illness: swelling, rash, cramps, fainting, heat exhaustion, heat stroke and the worsening of some health conditions.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n", + "alertDetailsLanguageCode": "en-CA" + } + ] + }, + { + "countryCode": "CA", + "alertId": 242633, + "description": { + "localized": "Heat Warning", + "english": "Heat Warning" + }, + "category": "NON-PRECIPITATION", + "priority": 31, + "source": "Environment Canada", + "sourceId": 3, + "alertAreas": [ + { + "name": "Kirkland Lake - Englehart", + "summary": "Heat Warning in effect until 9:25 PM EDT. Source: Environment Canada", + "startTime": "2020-07-01T09:25:59+00:00", + "endTime": "2020-07-02T01:25:59+00:00", + "latestStatus": { + "localized": "New", + "english": "New" + }, + "alertDetails": "\nA heat event is expected through Thursday. \n\nDaytime high temperatures in the low thirties on Wednesday and Thursday with overnight lows near 18 degrees Celsius are expected. This heat event may be extended into the weekend with daytime high temperatures near 30 degrees Celsius. \n\nPlease refer to your public forecast for further details on expected temperatures. \n\nHot and humid air can also bring deteriorating air quality and can result in the Air Quality Health Index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n", + "alertDetailsLanguageCode": "en-CA" + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetStormCurrentLocation.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetStormCurrentLocation.json new file mode 100644 index 000000000000..ae6cae72aa18 --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetStormCurrentLocation.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "year": 2021, + "basinId": "NP", + "govId": 2, + "current": true + }, + "responses": { + "200": { + "body": { + "results": [ + { + "dateTime": "2021-04-24T18:00:00+00:00", + "location": { + "latitude": 21.7, + "longitude": 134.1 + }, + "maxWindGust": { + "value": 92.6, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 74.1, + "unit": "km/h", + "unitType": 7 + }, + "movement": { + "direction": { + "degrees": 115.0, + "localizedDescription": "ESE" + }, + "speed": { + "value": 22.2, + "unit": "km/h", + "unitType": 7 + } + }, + "status": "Tropical Storm" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetStormForecast.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetStormForecast.json new file mode 100644 index 000000000000..6fb9c549ec60 --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetStormForecast.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "year": 2021, + "basinId": "NP", + "govId": 2 + }, + "responses": { + "200": { + "body": { + "results": [ + { + "dateTime": "2021-04-25T06:00:00+00:00", + "initializedDateTime": "2021-04-24T18:00:00+00:00", + "location": { + "latitude": 22.0, + "longitude": 137.8 + }, + "maxWindGust": { + "value": 92.6, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 74.1, + "unit": "km/h", + "unitType": 7 + }, + "status": "Tropical Storm", + "window": { + "left": { + "latitude": 22.56387, + "longitude": 137.739517 + }, + "right": { + "latitude": 21.4361, + "longitude": 137.860489 + } + } + }, + { + "dateTime": "2021-04-25T18:00:00+00:00", + "initializedDateTime": "2021-04-24T18:00:00+00:00", + "location": { + "latitude": 23.7, + "longitude": 142.4 + }, + "maxWindGust": { + "value": 92.6, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 74.1, + "unit": "km/h", + "unitType": 7 + }, + "status": "Tropical Storm", + "window": { + "left": { + "latitude": 24.45283, + "longitude": 142.055313 + }, + "right": { + "latitude": 22.94641, + "longitude": 142.744675 + } + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetStormLocations.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetStormLocations.json new file mode 100644 index 000000000000..33cdffde52e1 --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetStormLocations.json @@ -0,0 +1,365 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "year": 2021, + "basinId": "NP", + "govId": 1 + }, + "responses": { + "200": { + "body": { + "results": [ + { + "dateTime": "2021-02-22T00:00:00+00:00", + "location": { + "latitude": 10.4, + "longitude": 125.7 + }, + "maxWindGust": { + "value": 64.8, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 46.3, + "unit": "km/h", + "unitType": 7 + }, + "movement": { + "direction": { + "degrees": 305.0, + "localizedDescription": "NW" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "status": "Tropical Depression" + }, + { + "dateTime": "2021-02-21T18:00:00+00:00", + "location": { + "latitude": 10.2, + "longitude": 125.9 + }, + "maxWindGust": { + "value": 64.8, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 46.3, + "unit": "km/h", + "unitType": 7 + }, + "movement": { + "direction": { + "degrees": 300.0, + "localizedDescription": "WNW" + }, + "speed": { + "value": 22.2, + "unit": "km/h", + "unitType": 7 + } + }, + "status": "Tropical Depression" + }, + { + "dateTime": "2021-02-21T12:00:00+00:00", + "location": { + "latitude": 10.3, + "longitude": 125.8 + }, + "maxWindGust": { + "value": 83.3, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 64.8, + "unit": "km/h", + "unitType": 7 + }, + "movement": { + "direction": { + "degrees": 300.0, + "localizedDescription": "WNW" + }, + "speed": { + "value": 42.6, + "unit": "km/h", + "unitType": 7 + } + }, + "status": "Tropical Storm" + }, + { + "dateTime": "2021-02-19T06:00:00+00:00", + "location": { + "latitude": 7.2, + "longitude": 129.8 + }, + "maxWindGust": { + "value": 101.9, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 83.3, + "unit": "km/h", + "unitType": 7 + }, + "movement": { + "direction": { + "degrees": 270.0, + "localizedDescription": "W" + }, + "speed": { + "value": 18.5, + "unit": "km/h", + "unitType": 7 + } + }, + "status": "Tropical Storm" + }, + { + "dateTime": "2021-02-19T00:00:00+00:00", + "location": { + "latitude": 7.2, + "longitude": 131.2 + }, + "maxWindGust": { + "value": 101.9, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 83.3, + "unit": "km/h", + "unitType": 7 + }, + "movement": { + "direction": { + "degrees": 270.0, + "localizedDescription": "W" + }, + "speed": { + "value": 7.4, + "unit": "km/h", + "unitType": 7 + } + }, + "status": "Tropical Storm" + }, + { + "dateTime": "2021-02-18T18:00:00+00:00", + "location": { + "latitude": 7.2, + "longitude": 131.7 + }, + "maxWindGust": { + "value": 83.3, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 64.8, + "unit": "km/h", + "unitType": 7 + }, + "movement": { + "direction": { + "degrees": 270.0, + "localizedDescription": "W" + }, + "speed": { + "value": 3.7, + "unit": "km/h", + "unitType": 7 + } + }, + "status": "Tropical Storm" + }, + { + "dateTime": "2021-02-18T12:00:00+00:00", + "location": { + "latitude": 7.3, + "longitude": 131.8 + }, + "maxWindGust": { + "value": 83.3, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 64.8, + "unit": "km/h", + "unitType": 7 + }, + "movement": { + "direction": { + "degrees": 270.0, + "localizedDescription": "W" + }, + "speed": { + "value": 5.6, + "unit": "km/h", + "unitType": 7 + } + }, + "status": "Tropical Storm" + }, + { + "dateTime": "2021-02-18T06:00:00+00:00", + "location": { + "latitude": 7.3, + "longitude": 132.1 + }, + "maxWindGust": { + "value": 83.3, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 64.8, + "unit": "km/h", + "unitType": 7 + }, + "movement": { + "direction": { + "degrees": 305.0, + "localizedDescription": "NW" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "status": "Tropical Storm" + }, + { + "dateTime": "2021-02-18T00:00:00+00:00", + "location": { + "latitude": 7.0, + "longitude": 132.6 + }, + "maxWindGust": { + "value": 83.3, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 64.8, + "unit": "km/h", + "unitType": 7 + }, + "movement": { + "direction": { + "degrees": 290.0, + "localizedDescription": "WNW" + }, + "speed": { + "value": 5.6, + "unit": "km/h", + "unitType": 7 + } + }, + "status": "Tropical Storm" + }, + { + "dateTime": "2021-02-17T18:00:00+00:00", + "location": { + "latitude": 7.0, + "longitude": 132.7 + }, + "maxWindGust": { + "value": 74.1, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 55.6, + "unit": "km/h", + "unitType": 7 + }, + "movement": { + "direction": { + "degrees": 290.0, + "localizedDescription": "WNW" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "status": "Tropical Depression" + }, + { + "dateTime": "2021-02-17T12:00:00+00:00", + "location": { + "latitude": 6.8, + "longitude": 132.4 + }, + "maxWindGust": { + "value": 74.1, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 55.6, + "unit": "km/h", + "unitType": 7 + }, + "movement": { + "direction": { + "degrees": 285.0, + "localizedDescription": "WNW" + }, + "speed": { + "value": 13.0, + "unit": "km/h", + "unitType": 7 + } + }, + "status": "Tropical Depression" + }, + { + "dateTime": "2021-02-17T06:00:00+00:00", + "location": { + "latitude": 6.6, + "longitude": 133.1 + }, + "maxWindGust": { + "value": 64.8, + "unit": "km/h", + "unitType": 7 + }, + "sustainedWind": { + "value": 46.3, + "unit": "km/h", + "unitType": 7 + }, + "movement": { + "direction": { + "degrees": 270.0, + "localizedDescription": "W" + }, + "speed": { + "value": 22.2, + "unit": "km/h", + "unitType": 7 + } + }, + "status": "Tropical Depression" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetStormSearch.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetStormSearch.json new file mode 100644 index 000000000000..42e55bd8f4c6 --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetStormSearch.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "year": 2021, + "basinId": "AL" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "year": "2021", + "basinId": "AL", + "govId": 1, + "name": "Ana", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 2, + "name": "Bill", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 3, + "name": "Claudette", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 4, + "name": "Danny", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 5, + "name": "Elsa", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 6, + "name": "Fred", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 7, + "name": "Grace", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 8, + "name": "Henri", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 9, + "name": "Ida", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 10, + "name": "Kate", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 11, + "name": "Julian", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 12, + "name": "Larry", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 13, + "name": "Mindy", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 14, + "name": "Nicholas", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 15, + "name": "ODETTE", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 16, + "name": "Peter", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 17, + "name": "Rose", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 18, + "name": "Sam", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 19, + "name": "Teresa", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 20, + "name": "Victor", + "isActive": false, + "isRetired": false, + "isSubtropical": false + }, + { + "year": "2021", + "basinId": "AL", + "govId": 21, + "name": "Wanda", + "isActive": false, + "isRetired": false, + "isSubtropical": false + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetWeatherAlongRoute.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetWeatherAlongRoute.json new file mode 100644 index 000000000000..05775c4ffba5 --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetWeatherAlongRoute.json @@ -0,0 +1,308 @@ +{ + "parameters": { + "api-version": "1.1", + "format": "json", + "query": "38.907,-77.037,0:38.907,-77.009,10:38.926,-76.928,20:39.033,-76.852,30:39.168,-76.732,40:39.269,-76.634,50:39.287,-76.612,60" + }, + "responses": { + "200": { + "body": { + "summary": { + "iconCode": 35, + "hazards": { + "maxHazardIndex": 0 + } + }, + "waypoints": [ + { + "iconCode": 38, + "shortPhrase": "Mostly cloudy", + "isDayTime": false, + "cloudCover": 70, + "temperature": { + "value": 3.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 142 + }, + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 3, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 90, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 38, + "shortPhrase": "Mostly cloudy", + "isDayTime": false, + "cloudCover": 65, + "temperature": { + "value": 3.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 166 + }, + "speed": { + "value": 1, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 77, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 35, + "shortPhrase": "Partly cloudy", + "isDayTime": false, + "cloudCover": 43, + "temperature": { + "value": 3.2, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 163 + }, + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 44, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 35, + "shortPhrase": "Partly cloudy", + "isDayTime": false, + "cloudCover": 34, + "temperature": { + "value": 1.6, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 189 + }, + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 4, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 32, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 38, + "shortPhrase": "Mostly cloudy", + "isDayTime": false, + "cloudCover": 54, + "temperature": { + "value": 0.5, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 202 + }, + "speed": { + "value": 4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 5, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 36, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 35, + "shortPhrase": "Partly cloudy", + "isDayTime": false, + "cloudCover": 46, + "temperature": { + "value": 2.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 222 + }, + "speed": { + "value": 4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 5, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 38, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 35, + "shortPhrase": "Partly cloudy", + "isDayTime": false, + "cloudCover": 39, + "temperature": { + "value": 2.3, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 231 + }, + "speed": { + "value": 4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 5, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 43, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/stable/1.1/weather.json b/specification/maps/data-plane/Weather/stable/1.1/weather.json new file mode 100644 index 000000000000..30df0095f59e --- /dev/null +++ b/specification/maps/data-plane/Weather/stable/1.1/weather.json @@ -0,0 +1,3948 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Weather Service", + "version": "1.1" + }, + "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 creating an [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 key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this 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": { + "Pollutants": { + "name": "pollutants", + "in": "query", + "type": "boolean", + "x-ms-client-name": "includePollutantDetails", + "required": false, + "description": "Boolean value that returns detailed information about each pollutant. By default is True.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "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" + }, + "WeatherYear": { + "name": "year", + "description": "Year of the cyclone(s)", + "type": "integer", + "format": "int32", + "required": true, + "in": "query", + "x-ms-parameter-location": "method" + }, + "RequiredWeatherBasinId": { + "name": "basinId", + "type": "string", + "description": "Basin identifier", + "required": true, + "in": "query", + "enum": [ + "AL", + "EP", + "SI", + "NI", + "CP", + "NP", + "SP" + ], + "x-ms-enum": { + "name": "basinId", + "modelAsString": true, + "values": [ + { + "value": "AL", + "description": "Atlantic" + }, + { + "value": "EP", + "description": "Eastern Pacific" + }, + { + "value": "SI", + "description": "Southwest Indian Ocean" + }, + { + "value": "NI", + "description": "North Indian Ocean" + }, + { + "value": "CP", + "description": "Central Pacific" + }, + { + "value": "NP", + "description": "Northwest Pacific" + }, + { + "value": "SP", + "description": "South Pacific" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "OptionalWeatherBasinId": { + "name": "basinId", + "type": "string", + "description": "Basin identifier", + "in": "query", + "enum": [ + "AL", + "EP", + "SI", + "NI", + "CP", + "NP", + "SP" + ], + "x-ms-enum": { + "name": "basinId", + "modelAsString": true, + "values": [ + { + "value": "AL", + "description": "Atlantic" + }, + { + "value": "EP", + "description": "Eastern Pacific" + }, + { + "value": "SI", + "description": "Southwest Indian Ocean" + }, + { + "value": "NI", + "description": "North Indian Ocean" + }, + { + "value": "CP", + "description": "Central Pacific" + }, + { + "value": "NP", + "description": "Northwest Pacific" + }, + { + "value": "SP", + "description": "South Pacific" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "RequiredWeatherGovernmentId": { + "name": "govId", + "description": "Government storm Id", + "x-ms-client-name": "governmentStormId", + "type": "integer", + "format": "int32", + "required": true, + "in": "query", + "x-ms-parameter-location": "method" + }, + "OptionalWeatherGovernmentId": { + "name": "govId", + "description": "Government storm Id", + "x-ms-client-name": "governmentStormId", + "type": "integer", + "format": "int32", + "in": "query", + "x-ms-parameter-location": "method" + }, + "WeatherDetails": { + "name": "details", + "description": "When true, wind radii summary data is included in the response", + "x-ms-client-name": "includeDetails", + "in": "query", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "WeatherRadiiGeometry": { + "name": "radiiGeometry", + "description": "When true, wind radii summary data and geoJSON details are included in the response", + "x-ms-client-name": "includeGeometricDetails", + "in": "query", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "Position": { + "name": "query", + "in": "query", + "x-ms-client-name": "coordinates", + "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" + } + } + }, + "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" + }, + { + "$ref": "#/parameters/Position" + }, + { + "$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/HourlyForecastResult" + } + }, + "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" + }, + { + "$ref": "#/parameters/Position" + }, + { + "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/MinuteForecastResult" + } + }, + "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" + }, + { + "$ref": "#/parameters/Position" + }, + { + "$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/QuarterDayForecastResult" + } + }, + "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" + }, + { + "$ref": "#/parameters/Position" + }, + { + "$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/CurrentConditionsResult" + } + }, + "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" + }, + { + "$ref": "#/parameters/Position" + }, + { + "$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/DailyForecastResult" + } + }, + "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/WeatherAlongRouteResult" + } + }, + "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" + }, + { + "$ref": "#/parameters/Position" + }, + { + "$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/SevereWeatherAlertsResult" + } + }, + "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" + }, + { + "$ref": "#/parameters/Position" + }, + { + "$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/DailyIndicesResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/tropical/storms/active/{format}": { + "get": { + "description": "**Get Tropical Storm Active**\n\n**Applies to**: Gen 1 (S0 and S1) and Gen 2 pricing tiers.\n\nGet all government-issued active tropical storms. Information about the tropical storms includes, government ID, basin ID, year of origin, name and if it is subtropical.", + "operationId": "Weather_GetTropicalStormActive", + "x-ms-examples": { + "Get Tropical Storm Active": { + "$ref": "./examples/GetActiveStorms.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActiveStormResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/tropical/storms/{format}": { + "get": { + "description": "**Get Tropical Storm Search**\n\n**Applies to**: Gen 1 (S0 and S1) and Gen 2 pricing tiers.\n\nSearch government-issued tropical storms by year, basin ID, and government ID. Information about the tropical storms includes, government ID, basin ID, status, year, name and if it is subtropical.", + "operationId": "Weather_GetTropicalStormSearch", + "x-ms-client-name": "SearchTropicalStorm", + "x-ms-examples": { + "Get Tropical Storm Search": { + "$ref": "./examples/GetStormSearch.json" + }, + "Get Tropical Storm Search With Three Properties": { + "$ref": "./examples/GetFullStormSearch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" + }, + { + "$ref": "#/parameters/WeatherYear" + }, + { + "$ref": "#/parameters/OptionalWeatherBasinId" + }, + { + "$ref": "#/parameters/OptionalWeatherGovernmentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StormSearchResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/tropical/storms/forecasts/{format}": { + "get": { + "description": "**Get Tropical Storm Forecasts**\n\n**Applies to**: Gen 1 (S0 and S1) and Gen 2 pricing tiers.\n\nGet individual government-issued tropical storm forecasts. Information about the forecasted tropical storms includes, location, status, date the forecast was created, window, wind speed and wind radii.", + "operationId": "Weather_GetTropicalStormForecast", + "x-ms-examples": { + "Get Tropical Storm Forecasts": { + "$ref": "./examples/GetStormForecast.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" + }, + { + "$ref": "#/parameters/WeatherYear" + }, + { + "$ref": "#/parameters/RequiredWeatherBasinId" + }, + { + "$ref": "#/parameters/RequiredWeatherGovernmentId" + }, + { + "$ref": "#/parameters/WeatherDataUnit" + }, + { + "$ref": "#/parameters/WeatherDetails" + }, + { + "$ref": "#/parameters/WeatherRadiiGeometry" + }, + { + "name": "windowGeometry", + "description": "When true, window geometry data (geoJSON) is included in the response", + "x-ms-client-name": "includeWindowGeometry", + "in": "query", + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StormForecastResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/tropical/storms/locations/{format}": { + "get": { + "description": "**Get Tropical Storm Locations**\n\n**Applies to**: Gen 1 (S0 and S1) and Gen 2 pricing tiers.\n\nGet location of individual government-issued tropical storms. Information about the tropical storms includes, location coordinates, geometry, basin ID, date, wind details and wind radii.", + "operationId": "Weather_GetTropicalStormLocations", + "x-ms-examples": { + "Get Tropical Storm Locations": { + "$ref": "./examples/GetStormLocations.json" + }, + "Get Tropical Storm Current Location": { + "$ref": "./examples/GetStormCurrentLocation.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" + }, + { + "$ref": "#/parameters/WeatherYear" + }, + { + "$ref": "#/parameters/RequiredWeatherBasinId" + }, + { + "$ref": "#/parameters/RequiredWeatherGovernmentId" + }, + { + "$ref": "#/parameters/WeatherDetails" + }, + { + "$ref": "#/parameters/WeatherRadiiGeometry" + }, + { + "$ref": "#/parameters/WeatherDataUnit" + }, + { + "name": "current", + "description": "When true, return the current storm location", + "x-ms-client-name": "includeCurrentStorm", + "in": "query", + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StormLocationsResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/airQuality/current/{format}": { + "get": { + "description": "**Get Current Air Quality**\n\n**Applies to**: Gen 1 (S0 and S1) and Gen 2 pricing tiers.\n\nGet detailed information about the concentration of pollutants and overall status for current air quality. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", + "operationId": "Weather_GetCurrentAirQuality", + "x-ms-examples": { + "Get Current Air Quality": { + "$ref": "./examples/GetCurrentAirQuality.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/Language" + }, + { + "$ref": "#/parameters/Position" + }, + { + "$ref": "#/parameters/Pollutants" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AirQualityResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/airQuality/forecasts/daily/{format}": { + "get": { + "description": "**Get Air Quality Daily Forecasts**\n\n**Applies to**: Gen 1 (S0 and S1) and Gen 2 pricing tiers.\n\nGet detailed information about the concentration of pollutants and overall status of forecasted daily air quality. The service can provide forecasted daily air quality information for the upcoming 1 to 7 days. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", + "operationId": "Weather_GetAirQualityDailyForecasts", + "x-ms-examples": { + "Get Daily Air Quality Forecasts": { + "$ref": "./examples/GetDailyAirQuality.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/Language" + }, + { + "$ref": "#/parameters/Position" + }, + { + "name": "duration", + "description": "Specifies for how many days from now we would like to know about the air quality. Available values are 1, 2, 3, 4, 5, 6, and 7. Default value is 1.", + "default": 1, + "in": "query", + "type": "integer", + "format": "int32", + "enum": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7 + ], + "x-ms-enum": { + "name": "DailyDuration", + "modelAsString": true, + "values": [ + { + "name": "OneDay", + "value": 1, + "description": "1 day" + }, + { + "name": "TwoDays", + "value": 2, + "description": "2 days" + }, + { + "name": "ThreeDays", + "value": 3, + "description": "3 days" + }, + { + "name": "FourDays", + "value": 4, + "description": "4 days" + }, + { + "name": "FiveDays", + "value": 5, + "description": "5 days" + }, + { + "name": "SixDays", + "value": 6, + "description": "6 days" + }, + { + "name": "SevenDays", + "value": 7, + "description": "7 days" + } + ] + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DailyAirQualityForecastResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/airQuality/forecasts/hourly/{format}": { + "get": { + "description": "**Get Air Quality Hourly Forecasts**\n\n**Applies to**: Gen 1 (S0 and S1) and Gen 2 pricing tiers.\n\nGet detailed information about the concentration of pollutants and overall status for forecasted upcoming hourly air quality. The service can provide forecasted hourly air quality information for the upcoming time spans of 1, 12, 24, 48, 72, and 96 hours. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", + "operationId": "Weather_GetAirQualityHourlyForecasts", + "x-ms-examples": { + "Get Hourly Air Quality Forecasts": { + "$ref": "./examples/GetHourlyAirQuality.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/Language" + }, + { + "$ref": "#/parameters/Position" + }, + { + "name": "duration", + "description": "Specifies for how many hours from now we would like to know about the air quality. Available values are 1, 12, 24, 48, 72, 96. Default value is 1 hour.", + "default": 1, + "in": "query", + "type": "integer", + "format": "int32", + "enum": [ + 1, + 12, + 24, + 48, + 72, + 96 + ], + "x-ms-enum": { + "name": "HourlyDuration", + "modelAsString": true, + "values": [ + { + "name": "OneHour", + "value": 1, + "description": "1 Hours" + }, + { + "name": "TwelveHours", + "value": 12, + "description": "12 Hours" + }, + { + "name": "TwentyFourHours", + "value": 24, + "description": "24 Hours" + }, + { + "name": "FortyEightHours", + "value": 48, + "description": "48 Hours" + }, + { + "name": "SeventyTwoHours", + "value": 72, + "description": "72 Hours" + }, + { + "name": "NinetySixHours", + "value": 96, + "description": "96 Hours" + } + ] + } + }, + { + "$ref": "#/parameters/Pollutants" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AirQualityResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/historical/actuals/daily/{format}": { + "get": { + "description": "**Get Daily Historical Actuals**\n \n \n**Applies to**: Gen 1 (S0 and S1) and Gen 2 pricing tiers.\n\n\nGet Daily Historical Actuals service returns climatology data such as past daily actual observed temperatures, precipitation, snowfall, snow depth and cooling/heating degree day information, for the day at a given coordinate location. The data is requested for a specified date range, up to 31 days in a single API request. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", + "operationId": "Weather_GetDailyHistoricalActuals", + "x-ms-examples": { + "Successful Daily Historical Actuals Request": { + "$ref": "./examples/GetDailyHistoricalActuals.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" + }, + { + "$ref": "#/parameters/Position" + }, + { + "name": "startDate", + "description": "Start date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", + "in": "query", + "type": "string", + "format": "date", + "required": true + }, + { + "name": "endDate", + "description": "End date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", + "in": "query", + "type": "string", + "format": "date", + "required": true + }, + { + "$ref": "#/parameters/WeatherDataUnit" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DailyHistoricalActualsResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/historical/records/daily/{format}": { + "get": { + "description": "**Get Daily Historical Records**\n \n \n**Applies to**: Gen 1 (S0 and S1) and Gen 2 pricing tiers.\n\n\nGet Daily Historical Records service returns climatology data such as past daily record temperatures, precipitation and snowfall at a given coordinate location. Availability of records data will vary by location. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", + "operationId": "Weather_GetDailyHistoricalRecords", + "x-ms-examples": { + "Successful Daily Historical Records Request": { + "$ref": "./examples/GetDailyHistoricalRecords.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" + }, + { + "$ref": "#/parameters/Position" + }, + { + "name": "startDate", + "description": "Start date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", + "in": "query", + "type": "string", + "format": "date", + "required": true + }, + { + "name": "endDate", + "description": "End date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", + "in": "query", + "type": "string", + "format": "date", + "required": true + }, + { + "$ref": "#/parameters/WeatherDataUnit" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DailyHistoricalRecordsResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/historical/normals/daily/{format}": { + "get": { + "description": "**Get Daily Historical Normals**\n \n \n**Applies to**: Gen 1 (S0 and S1) and Gen 2 pricing tiers.\n\n\nGet Daily Historical Normals service returns climatology data such as past daily normal temperatures, precipitation and cooling/heating degree day information for the day at a given coordinate location. Normals are a 30-year average for temperatures and precipitation for a specific location. As is standard practice in climatology, the 30-year average covers years 1991-2020, this data will be used for one decade and then will reset in the year 2030. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", + "operationId": "Weather_GetDailyHistoricalNormals", + "x-ms-examples": { + "Successful Daily Historical Normals Request": { + "$ref": "./examples/GetDailyHistoricalNormals.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" + }, + { + "$ref": "#/parameters/Position" + }, + { + "name": "startDate", + "description": "Start date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", + "in": "query", + "type": "string", + "format": "date", + "required": true + }, + { + "name": "endDate", + "description": "End date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", + "in": "query", + "type": "string", + "format": "date", + "required": true + }, + { + "$ref": "#/parameters/WeatherDataUnit" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DailyHistoricalNormalsResult" + } + }, + "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" + }, + { + "value": "Snow", + "description": "Snow" + }, + { + "value": "Ice", + "description": "Ice" + }, + { + "value": "Mix", + "description": "Mix" + } + ] + } + }, + "WeatherUnit": { + "x-ms-client-name": "WeatherValue", + "description": "Specific value of a given unit related to weather.", + "type": "object", + "properties": { + "value": { + "type": "number", + "format": "float", + "description": "Rounded value." + }, + "unit": { + "x-ms-client-name": "unitLabel", + "type": "string", + "description": "Type of unit for the returned value." + }, + "unitType": { + "$ref": "#/definitions/UnitType" + } + } + }, + "WindDetails": { + "type": "object", + "description": "Wind details being returned including speed and direction.", + "properties": { + "direction": { + "$ref": "#/definitions/WindDirection", + "description": "Wind direction" + }, + "speed": { + "$ref": "#/definitions/WeatherUnit", + "description": "Speed of the wind in specified unit." + } + } + }, + "WindDirection": { + "type": "object", + "properties": { + "degrees": { + "type": "integer", + "format": "int32", + "description": "Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359." + }, + "localizedDescription": { + "x-ms-client-name": "description", + "type": "string", + "description": "Direction abbreviation in the specified language." + } + }, + "description": "Wind direction" + }, + "WeatherUnitRange": { + "x-ms-client-name": "WeatherValueRange", + "type": "object", + "description": "Returned temperature values.", + "properties": { + "minimum": { + "$ref": "#/definitions/WeatherUnit", + "description": "Minimum temperature for the time period." + }, + "maximum": { + "$ref": "#/definitions/WeatherUnit", + "description": "Maximum temperature for the time period" + } + } + }, + "UVIndex": { + "type": "integer", + "format": "int32", + "description": "Measure of the strength of the ultraviolet radiation from the sun. Supported values are:\n * `0-2` - Low danger from the sun's UV rays or the average person.\n * `3-5` - Moderate risk of harm from unprotected sun exposure.\n * `6-7` - High risk of harm from unprotected sun exposure.\n * `8-10` - Very high risk of harm from unprotected sun exposure.\n * `11+` - Extreme risk of harm from unprotected sun exposure." + }, + "HazardIndex": { + "type": "integer", + "format": "int32", + "description": "A severity/hazard index.\n * `0` - No hazard.\n * `1` - Be informed, be aware.\n * `2` - Pay attention, be prepared.\n * `3` - Take action.\n * `4` - Life threatening, emergency.", + "enum": [ + 0, + 1, + 2, + 3, + 4 + ], + "x-ms-enum": { + "name": "HazardIndex", + "modelAsString": true, + "values": [ + { + "value": 0, + "name": "NoHazard", + "description": "No hazard" + }, + { + "value": 1, + "name": "Informed", + "description": "Be informed" + }, + { + "value": 2, + "name": "PayAttention", + "description": "Pay attention" + }, + { + "value": 3, + "name": "TakeAction", + "description": "Take action" + }, + { + "value": 4, + "name": "Emergency", + "description": "Emergency" + } + ] + } + }, + "HourlyForecast": { + "type": "object", + "properties": { + "date": { + "x-ms-client-name": "timestamp", + "type": "string", + "description": "Date and time of the forecast in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00.", + "format": "date-time" + }, + "iconCode": { + "$ref": "#/definitions/IconCode" + }, + "iconPhrase": { + "type": "string", + "description": "Phrase description of the weather icon." + }, + "hasPrecipitation": { + "type": "boolean", + "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + }, + "isDaylight": { + "type": "boolean", + "description": "Specifies whether or not it is daylight. True indicates day light." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "Temperature being returned." + }, + "realFeelTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade." + }, + "wetBulbTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "The temperature to which air may be cooled by evaporating water into it at constant pressure until it reaches saturation." + }, + "dewPoint": { + "$ref": "#/definitions/WeatherUnit", + "description": "The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation." + }, + "wind": { + "$ref": "#/definitions/WindDetails", + "description": "Wind details being returned including speed and direction." + }, + "windGust": { + "$ref": "#/definitions/WindDetails", + "description": "Wind gust. Wind gust is a sudden, brief increase in speed of the wind." + }, + "relativeHumidity": { + "type": "integer", + "format": "int32", + "description": "Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature." + }, + "visibility": { + "$ref": "#/definitions/WeatherUnit", + "description": "Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned." + }, + "ceiling": { + "x-ms-client-name": "cloudCeiling", + "$ref": "#/definitions/WeatherUnit", + "description": "Cloud ceiling in specified unit. The ceiling is a measurement of the height of the base of the lowest clouds." + }, + "uvIndex": { + "$ref": "#/definitions/UVIndex" + }, + "uvIndexPhrase": { + "x-ms-client-name": "uvIndexDescription", + "type": "string", + "description": "Phrase associated with the `uvIndex`." + }, + "precipitationProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of precipitation. For example, '20'." + }, + "rainProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of rain. For example, '50'." + }, + "snowProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of snow. For example, '50'." + }, + "iceProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of snow. For example, '5'." + }, + "totalLiquid": { + "$ref": "#/definitions/WeatherUnit", + "description": "Total liquid equivalent of precipitation during the forecast period." + }, + "rain": { + "$ref": "#/definitions/WeatherUnit", + "description": "Rain" + }, + "snow": { + "$ref": "#/definitions/WeatherUnit", + "description": "Snow" + }, + "ice": { + "$ref": "#/definitions/WeatherUnit", + "description": "Ice" + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + } + } + }, + "HourlyForecastResult": { + "type": "object", + "properties": { + "forecasts": { + "type": "array", + "description": "Forecast data for each returned hour.", + "readOnly": true, + "items": { + "$ref": "#/definitions/HourlyForecast" + } + } + } + }, + "MinuteForecastSummary": { + "type": "object", + "properties": { + "briefPhrase60": { + "type": "string", + "description": "Summary phrase for the next 60 minutes. Phrase length is approximately 60 characters." + }, + "shortPhrase": { + "x-ms-client-name": "shortDescription", + "type": "string", + "description": "Short summary phrase for the next 120 minutes. Phrase length is approximately 25 characters." + }, + "briefPhrase": { + "x-ms-client-name": "briefDescription", + "type": "string", + "description": "Summary phrase for the next 120 minutes. Phrase length is approximately 60 characters." + }, + "longPhrase": { + "type": "string", + "description": "Long summary phrase for the next 120 minutes. Phrase length is 60+ characters." + }, + "iconCode": { + "$ref": "#/definitions/IconCode" + } + }, + "description": "Phrase summaries for the entire forecast period." + }, + "IntervalSummary": { + "type": "object", + "properties": { + "startMinute": { + "type": "integer", + "format": "int32", + "description": "The first minute to which the summary applies." + }, + "endMinute": { + "type": "integer", + "format": "int32", + "description": "The last minute to which the summary applies." + }, + "totalMinutes": { + "type": "integer", + "format": "int32", + "description": "The number of minutes for which the summary applies." + }, + "shortPhrase": { + "x-ms-client-name": "shortDescription", + "type": "string", + "description": "Short summary phrase. Phrase length is approximately 25 characters." + }, + "briefPhrase": { + "x-ms-client-name": "briefDescription", + "type": "string", + "description": "Brief summary phrase. Phrase length is approximately 60 characters." + }, + "longPhrase": { + "type": "string", + "description": "Long summary phrase. Phrase length is 60+ characters." + }, + "iconCode": { + "$ref": "#/definitions/IconCode" + } + } + }, + "ForecastInterval": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The date and time for the start of the interval in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "minute": { + "type": "integer", + "format": "int32", + "description": "The first minute for the interval." + }, + "dbz": { + "x-ms-client-name": "decibelRelativeToZ", + "type": "number", + "format": "double", + "description": "A unit that represents forecasted precipitation intensity." + }, + "shortPhrase": { + "x-ms-client-name": "shortDescription", + "type": "string", + "description": "A short phrase describing precipitation condition for the interval." + }, + "threshold": { + "type": "string", + "description": "Key that specifies the threshold value. Along with precipitationType, can be used to determine the simplifiedColor. If dbz is zero, not present in the response." + }, + "color": { + "$ref": "#/definitions/ColorValue", + "description": "The full spectrum color that maps to the dBZ (decibel relative to Z). If dbz is zero, color is not present in the response." + }, + "simplifiedColor": { + "$ref": "#/definitions/ColorValue", + "description": "The band color that maps to the precipitation type and threshold. If dbz is zero, not present in the response." + }, + "precipitationType": { + "$ref": "#/definitions/PrecipitationType" + }, + "iconCode": { + "$ref": "#/definitions/IconCode" + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + } + } + }, + "MinuteForecastResult": { + "type": "object", + "properties": { + "summary": { + "readOnly": true, + "$ref": "#/definitions/MinuteForecastSummary" + }, + "intervalSummaries": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/IntervalSummary" + }, + "description": "Summary information for each interval in the forecast. The Summaries breaks down each potential interval where precipitation starts and stops." + }, + "intervals": { + "type": "array", + "description": "Forecast data for each interval in the forecast.", + "readOnly": true, + "items": { + "$ref": "#/definitions/ForecastInterval" + } + } + } + }, + "ColorValue": { + "type": "object", + "properties": { + "red": { + "type": "integer", + "format": "int32", + "description": "Red component of the RGB value." + }, + "green": { + "type": "integer", + "format": "int32", + "description": "Green component of the RGB value." + }, + "blue": { + "type": "integer", + "format": "int32", + "description": "Blue component of the RGB value" + }, + "hex": { + "type": "string", + "description": "Hexadecimal color value." + } + } + }, + "QuarterDayForecast": { + "type": "object", + "properties": { + "date": { + "x-ms-client-name": "dateTime", + "type": "string", + "format": "date-time", + "description": "Date of the forecast as example, 2019-10-27T00:00:00" + }, + "effectiveDate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the beginning of the forecast quarter displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "quarter": { + "description": "Quarter of the day.", + "type": "integer", + "format": "int32", + "enum": [ + 0, + 1, + 2, + 3 + ], + "x-ms-enum": { + "name": "DayQuarter", + "modelAsString": true, + "values": [ + { + "value": 0, + "name": "FirstQuarter", + "description": "7:00 am - 1:00 pm / 7:00- 13:00" + }, + { + "value": 1, + "name": "SecondQuarter", + "description": "1:00 pm - 7:00 pm/ 13:00- 19:00" + }, + { + "value": 2, + "name": "ThirdQuarter", + "description": "7:00 pm - 1:00 am/ 19:00 - 01:00" + }, + { + "value": 3, + "name": "ForthQuarter", + "description": "1:00 am - 7:00 am/ 01:00 - 07:00" + } + ] + } + }, + "iconCode": { + "$ref": "#/definitions/IconCode" + }, + "iconPhrase": { + "type": "string", + "description": "Phrase description of the icon. Displayed in specified language. For example, 'Sunny'." + }, + "phrase": { + "type": "string", + "description": "Short summary phrase summary for quarter." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "Temperature values for the quarter." + }, + "realFeelTemperature": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "RealFeel™ Temperature values for the quarter." + }, + "dewPoint": { + "$ref": "#/definitions/WeatherUnit", + "description": "The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation." + }, + "relativeHumidity": { + "type": "integer", + "format": "int32", + "description": "Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature." + }, + "wind": { + "$ref": "#/definitions/WindDetails", + "description": "Wind details being returned including speed and direction." + }, + "windGust": { + "$ref": "#/definitions/WindDetails", + "description": "Wind gust. Wind gust is a sudden, brief increase in speed of the wind." + }, + "visibility": { + "$ref": "#/definitions/WeatherUnit", + "description": "Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned." + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + }, + "hasPrecipitation": { + "type": "boolean", + "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + }, + "precipitationType": { + "$ref": "#/definitions/PrecipitationType" + }, + "precipitationIntensity": { + "type": "string", + "description": "Description of the intensity." + }, + "precipitationProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of precipitation. For example, '20'." + }, + "thunderstormProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of a thunderstorm. For example, '10'." + }, + "totalLiquid": { + "$ref": "#/definitions/WeatherUnit", + "description": "Total liquid equivalent of precipitation during the forecast period." + }, + "rain": { + "$ref": "#/definitions/WeatherUnit", + "description": "Rain" + }, + "snow": { + "$ref": "#/definitions/WeatherUnit", + "description": "Snow" + }, + "ice": { + "$ref": "#/definitions/WeatherUnit", + "description": "Ice" + } + } + }, + "QuarterDayForecastResult": { + "type": "object", + "properties": { + "forecasts": { + "readOnly": true, + "type": "array", + "description": "Forecast data for each quarter in the response.", + "items": { + "$ref": "#/definitions/QuarterDayForecast" + } + } + } + }, + "CurrentConditionsResult": { + "type": "object", + "properties": { + "results": { + "readOnly": true, + "description": "Detailed current weather conditions.", + "type": "array", + "items": { + "$ref": "#/definitions/CurrentConditions" + } + } + } + }, + "PressureTendency": { + "type": "object", + "properties": { + "localizedDescription": { + "x-ms-client-name": "description", + "type": "string", + "description": "Description of the pressure tendency in specified language" + }, + "code": { + "type": "string", + "description": "Pressure tendency code regardless of language. One of F=Falling, S=Steady, R=Rising." + } + } + }, + "PrecipitationSummary": { + "type": "object", + "properties": { + "pastHour": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past hour." + }, + "pastThreeHours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past three hours." + }, + "pastSixHours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past six hours. Contains Metric and Imperial Values." + }, + "pastNineHours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past nine hours." + }, + "pastTwelveHours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past 12 hours." + }, + "pastEighteenHours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past 18 hours." + }, + "pastTwentyFourHours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past 24 hours." + } + } + }, + "PastHoursTemperature": { + "type": "object", + "properties": { + "minimum": { + "$ref": "#/definitions/WeatherUnit", + "description": "minimum" + }, + "maximum": { + "$ref": "#/definitions/WeatherUnit", + "description": "maximum" + } + }, + "description": "Summary of temperature fluctuations over the number of past hours." + }, + "TemperatureSummary": { + "type": "object", + "properties": { + "pastSixHours": { + "$ref": "#/definitions/PastHoursTemperature", + "description": "Summary of temperature fluctuations over the past 6 hours." + }, + "pastTwelveHours": { + "$ref": "#/definitions/PastHoursTemperature", + "description": "Summary of temperature fluctuations over the past 12 hours." + }, + "pastTwentyFourHours": { + "$ref": "#/definitions/PastHoursTemperature", + "description": "Summary of temperature fluctuations over the past 24 hours." + } + } + }, + "CurrentConditions": { + "type": "object", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "phrase": { + "x-ms-client-name": "description", + "type": "string", + "description": "Phrase description of the current weather condition. Displayed in specified language." + }, + "iconCode": { + "$ref": "#/definitions/IconCode" + }, + "hasPrecipitation": { + "type": "boolean", + "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + }, + "isDayTime": { + "x-ms-client-name": "isDaytime", + "type": "boolean", + "description": "Indicates the time of the day. True indicates 'day',', false indicates 'night." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "Temperature being returned." + }, + "realFeelTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "RealFeel™ Temperature being returned." + }, + "realFeelTemperatureShade": { + "$ref": "#/definitions/WeatherUnit", + "description": "RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade." + }, + "relativeHumidity": { + "type": "integer", + "format": "int32", + "description": "Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature." + }, + "dewPoint": { + "$ref": "#/definitions/WeatherUnit", + "description": "The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation." + }, + "wind": { + "$ref": "#/definitions/WindDetails", + "description": "Wind details being returned including speed and direction." + }, + "windGust": { + "$ref": "#/definitions/WindDetails", + "description": "Wind gust. Wind gust is a sudden, brief increase in speed of the wind." + }, + "uvIndex": { + "$ref": "#/definitions/UVIndex" + }, + "uvIndexPhrase": { + "x-ms-client-name": "uvIndexDescription", + "type": "string", + "description": "Phrase associated with the `uvIndex`." + }, + "visibility": { + "$ref": "#/definitions/WeatherUnit", + "description": "Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned." + }, + "obstructionsToVisibility": { + "type": "string", + "description": "Cause of limited visibility." + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + }, + "ceiling": { + "x-ms-client-name": "cloudCeiling", + "$ref": "#/definitions/WeatherUnit", + "description": "Cloud ceiling in specified unit. The ceiling is a measurement of the height of the base of the lowest clouds." + }, + "pressure": { + "$ref": "#/definitions/WeatherUnit", + "description": "Atmospheric pressure in specified unit." + }, + "pressureTendency": { + "$ref": "#/definitions/PressureTendency", + "description": "Atmospheric pressure change." + }, + "pastTwentyFourHourTemperatureDeparture": { + "$ref": "#/definitions/WeatherUnit", + "description": "Departure from the temperature observed 24 hours ago in specified unit." + }, + "apparentTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "Perceived outdoor temperature caused by the combination of air temperature, relative humidity, and wind speed in specified unit." + }, + "windChillTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "Perceived air temperature on exposed skin due to wind." + }, + "wetBulbTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "The temperature to which air may be cooled by evaporating water into it at constant pressure until it reaches saturation." + }, + "precipitationSummary": { + "$ref": "#/definitions/PrecipitationSummary", + "description": "Summary of precipitation amounts over the past 24 hours." + }, + "temperatureSummary": { + "$ref": "#/definitions/TemperatureSummary", + "description": "Summary of temperature fluctuations over the past 6, 12, and 24 hours." + } + } + }, + "DailyForecastSummary": { + "type": "object", + "properties": { + "startDate": { + "type": "string", + "format": "date-time", + "description": "Date and time that the summary is in effect, displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "Date and time that the summary period ends, displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "severity": { + "type": "integer", + "format": "int32", + "description": "severity" + }, + "phrase": { + "type": "string", + "description": "Summary phrase of the daily forecast. Displayed in specified language." + }, + "category": { + "type": "string", + "description": "one or 2 word(s) to summarize the phrase." + } + }, + "description": "Summary for the main conditions for the requested time period. Notice that summary can cover only part of the time period." + }, + "DegreeDaySummary": { + "type": "object", + "properties": { + "heating": { + "$ref": "#/definitions/WeatherUnit", + "description": "Number of degrees that the mean temperature is below 65 degrees F/ 18 degree C." + }, + "cooling": { + "$ref": "#/definitions/WeatherUnit", + "description": "Number of degrees that the mean temperature is above 65 degrees F/ 18 degree C." + } + } + }, + "AirAndPollen": { + "type": "object", + "properties": { + "name": { + "x-ms-client-name": "description", + "type": "string", + "description": "Name of the pollen or pollutant. For example, grass, mold, weed, air quality, tree and UV index." + }, + "value": { + "type": "integer", + "format": "int32", + "description": "Value of the given type above. Values associated with mold, grass, weed and tree are in units of parts per cubic meter. Both air quality and UV are indices, so they are unitless." + }, + "category": { + "type": "string", + "description": "Category of the air quality or pollution type. For example, low, high, good, moderate, unhealthy, hazardous." + }, + "categoryValue": { + "type": "integer", + "format": "int32", + "description": "Value associated with the air quality or pollution category. These values range from 1 to 6. 1 implying good conditions, 6 implying hazardous conditions." + }, + "type": { + "x-ms-client-name": "airQualityType", + "type": "string", + "description": "Only exists for air quality. Examples include ozone and particle pollution." + } + } + }, + "DailyForecast": { + "type": "object", + "properties": { + "date": { + "x-ms-client-name": "dateTime", + "type": "string", + "format": "date-time", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "Temperature values for the day." + }, + "realFeelTemperature": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "RealFeel™ Temperature being returned." + }, + "realFeelTemperatureShade": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade." + }, + "hoursOfSun": { + "type": "number", + "format": "float", + "description": "Hours of sun." + }, + "degreeDaySummary": { + "x-ms-client-name": "meanTemperatureDeviation", + "$ref": "#/definitions/DegreeDaySummary", + "description": "Summary for mean temperature of Heating Degree Day or Cooling Degree Day information" + }, + "airAndPollen": { + "x-ms-client-name": "airQuality", + "type": "array", + "items": { + "$ref": "#/definitions/AirAndPollen" + }, + "description": "Air quality" + }, + "day": { + "x-ms-client-name": "daytimeForecast", + "$ref": "#/definitions/DayOrNight", + "description": "Day forecast detail" + }, + "night": { + "x-ms-client-name": "nighttimeForecast", + "$ref": "#/definitions/DayOrNight", + "description": "Night forecast detail" + }, + "sources": { + "description": "Source(s) of the forecast data.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DailyForecastResult": { + "type": "object", + "properties": { + "summary": { + "readOnly": true, + "$ref": "#/definitions/DailyForecastSummary" + }, + "forecasts": { + "type": "array", + "readOnly": true, + "description": "Forecast data for each requested day.", + "items": { + "$ref": "#/definitions/DailyForecast" + } + } + } + }, + "LocalSource": { + "description": "Local weather data provider information.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "Numeric identifier, unique to the local data provider." + }, + "name": { + "type": "string", + "description": "Name of the local data provider. Name is displayed in the language specified by language code in URL, if available. Otherwise, Name is displayed in English or the language in which the name was provided." + }, + "weatherCode": { + "type": "string", + "description": "Weather code provided by the local data provider. This weather code allows the forecast to be matched to icons provided by the local data provider instead of Azure Maps icons." + } + } + }, + "DayOrNight": { + "x-ms-client-name": "DailyForecastDetail", + "type": "object", + "properties": { + "iconCode": { + "$ref": "#/definitions/IconCode" + }, + "iconPhrase": { + "type": "string", + "description": "Phrase description of the icon. Displayed in specified language. For example, 'Sunny'." + }, + "localSource": { + "$ref": "#/definitions/LocalSource" + }, + "hasPrecipitation": { + "type": "boolean", + "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + }, + "precipitationType": { + "$ref": "#/definitions/PrecipitationType" + }, + "precipitationIntensity": { + "type": "string", + "description": "Description of the intensity." + }, + "shortPhrase": { + "x-ms-client-name": "shortDescription", + "type": "string", + "description": "Phrase description of the forecast in specified language. Azure Maps attempts to keep this phrase under 30 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 30 characters." + }, + "longPhrase": { + "type": "string", + "description": "Phrase description of the forecast in specified language. Azure Maps attempts to keep this phrase under 100 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 100 characters." + }, + "precipitationProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of precipitation. For example, '20'." + }, + "thunderstormProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of a thunderstorm. For example, '80'." + }, + "rainProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of rain. For example, '40'." + }, + "snowProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of snow. For example, '30'." + }, + "iceProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of ice. For example, '30'." + }, + "wind": { + "$ref": "#/definitions/WindDetails", + "description": "Wind details being returned including speed and direction." + }, + "windGust": { + "$ref": "#/definitions/WindDetails", + "description": "Wind gust. Wind gust is a sudden, brief increase in speed of the wind." + }, + "totalLiquid": { + "$ref": "#/definitions/WeatherUnit", + "description": "Total liquid equivalent of precipitation during the forecast period." + }, + "rain": { + "$ref": "#/definitions/WeatherUnit", + "description": "Rain" + }, + "snow": { + "$ref": "#/definitions/WeatherUnit", + "description": "Snow" + }, + "ice": { + "$ref": "#/definitions/WeatherUnit", + "description": "Ice" + }, + "hoursOfPrecipitation": { + "type": "number", + "format": "float", + "description": "Hours of precipitation" + }, + "hoursOfRain": { + "type": "number", + "format": "float", + "description": "Hours of rain." + }, + "hoursOfSnow": { + "type": "number", + "format": "float", + "description": "Hours of snow." + }, + "hoursOfIce": { + "type": "number", + "format": "float", + "description": "Hours of ice." + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + } + } + }, + "WeatherAlongRouteSummary": { + "description": "Short summary of the weather along the route.", + "type": "object", + "properties": { + "iconCode": { + "$ref": "#/definitions/IconCode" + }, + "hazards": { + "$ref": "#/definitions/WeatherHazards" + } + } + }, + "WeatherAlongRouteResult": { + "type": "object", + "description": "This object is returned from a successful Weather Along Route.", + "properties": { + "summary": { + "readOnly": true, + "$ref": "#/definitions/WeatherAlongRouteSummary" + }, + "waypoints": { + "readOnly": true, + "type": "array", + "description": "Data for each waypoint returned in the same order as specified in the request.", + "items": { + "$ref": "#/definitions/WeatherWaypoint" + } + } + } + }, + "WeatherAlongRoutePrecipitation": { + "description": "Precipitation forecast of the weather along the route.", + "type": "object", + "properties": { + "dbz": { + "type": "number", + "format": "double", + "description": "The forecasted precipitation intensity in dBZ (decibels relative to Z) from 0.0 to 100.0." + }, + "type": { + "type": "string", + "description": "Precipitation type. If precipitation should occur, the type that it will be: \"RAIN,\" \"HAIL,\" \"SNOW,\" \"ICE,\" or \"MIX.\"" + } + } + }, + "SunGlare": { + "type": "object", + "description": "A rating that indicates how blinding the sun is for the driver.", + "properties": { + "calculatedVehicleHeading": { + "type": "integer", + "format": "int32", + "description": "If the vehicle heading value is not provided for a waypoint, then the service will calculate a heading based upon the location of neighboring waypoints if provided." + }, + "glareIndex": { + "type": "integer", + "format": "int32", + "description": "An index from 0 to 100 indicating sun glare intensity for a driver. A value of 50 and above can be considered a hazard for some drivers and a value of 100 signifies the driver is driving straight into the sun and atmospheric conditions are clear allowing for the full intensity of the sun to blind the driver." + } + } + }, + "WeatherWaypoint": { + "x-ms-client-name": "WaypointForecast", + "type": "object", + "properties": { + "iconCode": { + "$ref": "#/definitions/IconCode" + }, + "shortPhrase": { + "x-ms-client-name": "shortDescription", + "type": "string", + "description": "A displayable short phrase describing the forecasted conditions and precipitation intensity/type." + }, + "isDayTime": { + "x-ms-client-name": "isDaytime", + "type": "boolean", + "description": "Indicates the time of the day. True indicates 'day',', false indicates 'night." + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnit" + }, + "wind": { + "$ref": "#/definitions/WindDetails" + }, + "windGust": { + "$ref": "#/definitions/WindDetails" + }, + "precipitation": { + "$ref": "#/definitions/WeatherAlongRoutePrecipitation" + }, + "lightningCount": { + "type": "integer", + "format": "int32", + "description": "Estimation of thunderstorm intensity on an open scale. A value of 0 means there is no thunderstorm; values of 1 and higher mean there is a thunderstorm in increasing intensity." + }, + "sunGlare": { + "$ref": "#/definitions/SunGlare", + "description": "A rating that indicates how blinding the sun is for the driver." + }, + "hazards": { + "$ref": "#/definitions/WeatherHazards" + }, + "notifications": { + "description": "List of weather hazard notifications.", + "type": "array", + "items": { + "$ref": "#/definitions/WeatherNotification" + } + } + } + }, + "WeatherHazards": { + "description": "Description of the weather hazard affecting the trip.", + "type": "object", + "properties": { + "maxHazardIndex": { + "$ref": "#/definitions/HazardIndex" + }, + "hazardDetails": { + "x-ms-client-name": "details", + "type": "array", + "description": "Details of the weather hazards affecting the trip.", + "items": { + "$ref": "#/definitions/HazardDetail" + } + } + } + }, + "HazardDetail": { + "type": "object", + "properties": { + "hazardIndex": { + "$ref": "#/definitions/HazardIndex" + }, + "hazardCode": { + "type": "string", + "description": "A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning." + }, + "shortPhrase": { + "x-ms-client-name": "shortDescription", + "type": "string", + "description": "A displayable short phrase describing the forecasted conditions and precipitation intensity/type." + } + } + }, + "WeatherNotification": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "A type of notification generated to warn drivers of the onset of a hazard, or increase in intensity of a hazard." + }, + "hazardIndex": { + "$ref": "#/definitions/HazardIndex" + }, + "hazardCode": { + "type": "string", + "description": "A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning." + }, + "shortPhrase": { + "x-ms-client-name": "shortDescription", + "type": "string", + "description": "A displayable short phrase describing the forecasted conditions and precipitation intensity/type." + } + } + }, + "SevereWeatherAlertsResult": { + "type": "object", + "description": "This object is returned from a successful Get Severe Weather Alerts call.", + "properties": { + "results": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SevereWeatherAlert" + }, + "description": "A list of all severe weather alerts for the queried location." + } + } + }, + "SevereWeatherAlert": { + "type": "object", + "description": "Information about a severe weather alert.", + "properties": { + "countryCode": { + "type": "string", + "description": "2-character ISO 3166-1 Alpha-2 country code, for example, \"US\"." + }, + "alertId": { + "type": "integer", + "format": "int32", + "description": "A unique numerical identifier for a weather alert." + }, + "description": { + "$ref": "#/definitions/SevereWeatherAlertDescription", + "description": "Description of the alert." + }, + "category": { + "type": "string", + "description": "Category of the alert." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Number signifying the importance or ranking order of the given alert within the country/region it has originated. A lower number signifies a higher priority. For example, 1 is the highest priority. The number varies by country/region and can change over time as each country/region evolves their alert systems." + }, + "class": { + "x-ms-client-name": "classification", + "type": "string", + "description": "Classification of the alert. This field is not available for all countries and therefore not always returned." + }, + "level": { + "type": "string", + "description": "Severity level of the alert. This field is not available for all countries and therefore not always returned." + }, + "source": { + "type": "string", + "description": "The provider of the alert information. By default the source is returned in English (en-US). The alerts are from official Government Meteorological Agencies and leading global weather alert providers." + }, + "sourceId": { + "type": "integer", + "format": "int32", + "description": "A numerical identifier associated with the source provider name of the alert data." + }, + "disclaimer": { + "type": "string", + "description": "A disclaimer regarding the source of the alert information. This field is not always available. For example, disclaimer may include details about the delays or potential issues related to the alarm." + }, + "alertAreas": { + "x-ms-client-name": "alertDetails", + "type": "array", + "items": { + "$ref": "#/definitions/AlertArea" + }, + "description": "Information about the alert specific to the affected area(s)." + } + } + }, + "SevereWeatherAlertDescription": { + "type": "object", + "description": "Description of a severe weather alert.", + "properties": { + "localized": { + "x-ms-client-name": "description", + "type": "string", + "description": "Description of the alert in the specified language. By default English (en-US) is returned if the language parameter is not specified in the request." + }, + "english": { + "x-ms-client-name": "status", + "type": "string", + "description": "Description of the alert in English (en-US)." + } + } + }, + "AlertArea": { + "x-ms-client-name": "AlertDetails", + "type": "object", + "description": "Information about a severe weather alert issued within an affected area(s). If multiple alerts are active for the same location, the alerts will be returned in order of `priority` within the API response, with the highest priority alert being returned at the top of the response.", + "properties": { + "name": { + "type": "string", + "description": "The name of an area which is affected by the alert. The location that was requested falls under the alert area." + }, + "summary": { + "x-ms-client-name": "description", + "type": "string", + "description": "Text summarizing the alert in the returned area." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. If the alert crosses multiple time zones the returned time in the response is the local time to the requested coordinate location." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. If the alert crosses multiple time zones the returned time in the response is the local time to the requested coordinate location." + }, + "latestStatus": { + "$ref": "#/definitions/LatestStatus", + "description": "The latest status of the alert in the current area." + }, + "alertDetails": { + "x-ms-client-name": "details", + "type": "string", + "description": "Full details associated with the alert. Returned if `details`=True. This field is always returned in the language(s) of choice by the issuing provider and Azure Maps only returns what is created by the provider. Please note, some countries/regions may offer their native language and English. Language parameter won’t apply to this field." + }, + "alertDetailsLanguageCode": { + "x-ms-client-name": "language", + "type": "string", + "description": "Language of the `alertDetails`. This field helps to point out that the language of the `alertDetails` may differ from the requested language parameter. Returned if `details`=True. Language code has been derived from the ISO 639-1 Alpha-2 codes." + } + } + }, + "LatestStatus": { + "type": "object", + "description": "The latest status on the alert in the current area.", + "properties": { + "localized": { + "type": "string", + "description": "The latest status keyword for the alert, in the specified language. By default, returned in English (en-US)." + }, + "english": { + "$ref": "#/definitions/LatestStatusKeyword", + "description": "Latest status keyword for the alert, in English (en-US)." + } + } + }, + "LatestStatusKeyword": { + "type": "string", + "description": "Keyword for the latest status of the alert.", + "enum": [ + "New", + "Extend", + "Cancel", + "Correct", + "Expire", + "Upgrade", + "Continue", + "Update" + ], + "x-ms-enum": { + "name": "LatestStatusKeyword", + "modelAsString": true, + "values": [ + { + "value": "New", + "description": "\"New\" - the status of an alert upon initial issuance." + }, + { + "value": "Extend", + "description": "\"Extend\" - the alert has been extended in time, in area, or both since its initial issuance." + }, + { + "value": "Cancel", + "description": "\"Cancel\" - the alert has been canceled prior to its original expiration time." + }, + { + "value": "Correct", + "description": "\"Correct\" - the alert has been modified to correct a previous error." + }, + { + "value": "Expire", + "description": "\"Expire\" - the alert has expired and is no longer active." + }, + { + "value": "Upgrade", + "description": "\"Upgrade\" - the alert has been upgraded to a higher class or category since its initial issuance." + }, + { + "value": "Continue", + "description": "\"Continue\" - the alert has been updated since its initial issuance, but no changes were made to `alertDetails`, `startTime`, `endTime`, or `class`." + }, + { + "value": "Update", + "description": "\"Update\" - the alert has been updated since its initial issuance." + } + ] + } + }, + "DailyIndicesResult": { + "type": "object", + "description": "This object is returned from a successful Get Daily Indices call.", + "properties": { + "results": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DailyIndex" + }, + "description": "A list of all daily indices for the queried location." + } + } + }, + "DailyIndex": { + "type": "object", + "description": "Information about a daily index.", + "properties": { + "indexName": { + "type": "string", + "description": "Name of the index, for example, \"Construction\", \"Outdoor Activity\", \"Flight Delays\"." + }, + "indexId": { + "type": "integer", + "format": "int32", + "description": "Numeric ID used to identify the specific index. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index IDs. For example, the index ID can support UI visualization scenarios." + }, + "dateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "value": { + "type": "number", + "format": "float", + "description": "Index value. Ranges from 0.0 to 10.0. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported ranges." + }, + "category": { + "x-ms-client-name": "categoryDescription", + "type": "string", + "description": "Textual description for `categoryValue` corresponding to the level that the index value falls under, for example \"Very Good\"." + }, + "categoryValue": { + "type": "integer", + "format": "int32", + "description": "Level that the index value falls under, represented by an integer. This value can be 1 through 5 and should be used in combination with the `ascending` flag because it can differ among indices. For example, the following values apply for Mosquito Activity: Low=1, Moderate=2, High=3, Very High=4, and Extreme=5." + }, + "ascending": { + "x-ms-client-name": "isAscending", + "type": "boolean", + "description": "Describes the direction of the `value` and `categoryValue`. For example, when set to `true`, the poorest index value is 0 and the best index value is 10. When set to `true`, the poorest index value is 10 and the best index value is 0." + }, + "description": { + "type": "string", + "description": "A textual explanation that can be used for display purposes to summarize the index value and category. For example, when the index value for Flight Delays is very good, the description will be \"Conditions are excellent for flying!\"." + } + } + }, + "ActiveStormResult": { + "type": "object", + "description": "All government-issued active storms", + "properties": { + "results": { + "type": "array", + "x-ms-client-name": "activeStorms", + "items": { + "$ref": "#/definitions/ActiveStorm" + }, + "description": "All government-issued active storms" + }, + "nextLink": { + "$ref": "#/definitions/NextLink" + } + } + }, + "ActiveStorm": { + "type": "object", + "description": "Government-issued active storm", + "properties": { + "year": { + "type": "string", + "description": "Year of origination" + }, + "basinId": { + "$ref": "#/definitions/basinId", + "description": "Basin identifier (AL, EP, SI, NI, CP, NP, SP)" + }, + "name": { + "type": "string", + "description": "The name of the depression." + }, + "isActive": { + "type": "boolean", + "description": "True if the depression has been updated recently." + }, + "isSubtropical": { + "type": "boolean", + "description": "True when the depression is classified as a subtropical cyclone." + }, + "govId": { + "type": "integer", + "format": "int32", + "description": "Government storm ID. This will match the depression number." + } + } + }, + "basinId": { + "type": "string", + "description": "Basin identifier", + "enum": [ + "AL", + "EP", + "SI", + "NI", + "CP", + "NP", + "SP" + ], + "x-ms-enum": { + "name": "basinId", + "modelAsString": true, + "values": [ + { + "value": "AL", + "description": "Atlantic" + }, + { + "value": "EP", + "description": "Eastern Pacific" + }, + { + "value": "SI", + "description": "Southwest Indian Ocean" + }, + { + "value": "NI", + "description": "North Indian Ocean" + }, + { + "value": "CP", + "description": "Central Pacific" + }, + { + "value": "NP", + "description": "Northwest Pacific" + }, + { + "value": "SP", + "description": "South Pacific" + } + ] + } + }, + "StormSearchResult": { + "type": "object", + "description": "Search government-issued storms", + "properties": { + "results": { + "type": "array", + "x-ms-client-name": "storms", + "items": { + "$ref": "#/definitions/StormSearchResultItem" + }, + "description": "Search government-issued storms" + }, + "nextLink": { + "$ref": "#/definitions/NextLink" + } + } + }, + "StormSearchResultItem": { + "type": "object", + "description": "Government-issued active storm event", + "properties": { + "year": { + "type": "string", + "description": "Year of origination" + }, + "basinId": { + "$ref": "#/definitions/basinId", + "description": "Basin identifier (AL, EP, SI, NI, CP, NP, SP)" + }, + "name": { + "type": "string", + "description": "The name of the depression." + }, + "isActive": { + "type": "boolean", + "description": "True if the depression has been updated recently." + }, + "isRetired": { + "type": "boolean", + "description": "True if the storm name has been permanently retired in the source basin." + }, + "isSubtropical": { + "type": "boolean", + "description": "True when the depression is classified as a subtropical cyclone." + }, + "govId": { + "type": "integer", + "format": "int32", + "description": "Government storm ID. This will match the depression number." + } + } + }, + "StormForecastResult": { + "type": "object", + "description": "The list of Government-issued forecasts", + "properties": { + "results": { + "type": "array", + "x-ms-client-name": "stormForecasts", + "items": { + "$ref": "#/definitions/StormForecast" + }, + "description": "The list of Government-issued forecasts" + }, + "nextLink": { + "$ref": "#/definitions/NextLink" + } + } + }, + "StormForecast": { + "type": "object", + "description": "Government-issued storm forecast", + "properties": { + "dateTime": { + "type": "string", + "x-ms-client-name": "timestamp", + "description": "Datetime the forecast is valid, displayed in ISO8601 format." + }, + "initializedDateTime": { + "type": "string", + "x-ms-client-name": "initialized_timestamp", + "description": "Datetime the forecast was created, displayed in ISO8601 format." + }, + "location": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPair", + "x-ms-client-name": "coordinates", + "description": "Coordinates of the storm" + }, + "maxWindGust": { + "$ref": "#/definitions/WeatherUnit", + "description": "Maximum wind gust speed associated with the storm. May be NULL." + }, + "sustainedWind": { + "$ref": "#/definitions/WeatherUnit", + "description": "Maximum sustained wind speed associated with the storm. May be NULL." + }, + "status": { + "type": "string", + "description": "Storm status" + }, + "window": { + "$ref": "#/definitions/WeatherWindow", + "x-ms-client-name": "WeatherWindow", + "description": "Contains information about the forecast window for the storm during the specified time period (not the entire cone). If windowGeometry=true in the request, this object will include geoJSON details for window geometry." + }, + "windRadiiSummary": { + "type": "array", + "items": { + "$ref": "#/definitions/StormWindRadiiSummary" + }, + "description": "Displayed when details=true or radiiGeometry=true in the request." + } + } + }, + "WeatherWindow": { + "type": "object", + "description": "Forecast window for the storm", + "properties": { + "left": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPair", + "x-ms-client-name": "topLeft", + "description": "Location of the point on the left side of the window at the time of the timeframe." + }, + "right": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPair", + "x-ms-client-name": "bottomRight", + "description": "Location of the point on the right side of the window at the end of the timeframe." + }, + "beginDateTime": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "begin_timestamp", + "description": "DateTime of the beginning of the window of movement, displayed in ISO8601 format." + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "end_timestamp", + "description": "DateTime of the end of the window of movement, displayed in ISO8601 format." + }, + "beginStatus": { + "type": "string", + "description": "Storm status at the beginning of the window." + }, + "endStatus": { + "type": "string", + "description": "Storm status at the end of the window." + }, + "geometry": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonGeometry", + "description": "Displayed when windowGeometry=true in request. GeoJSON object containing coordinates describing the window of movement during the specified timeframe." + } + } + }, + "StormWindRadiiSummary": { + "type": "object", + "description": "Displayed when details=true or radiiGeometry=true in the request.", + "properties": { + "dateTime": { + "type": "string", + "x-ms-client-name": "timestamp", + "description": "DateTime for which the wind radii summary data is valid, displayed in ISO8601 format." + }, + "windSpeed": { + "$ref": "#/definitions/WeatherUnit", + "description": "Wind speed associated with the radiusSectorData." + }, + "radiusSectorData": { + "type": "array", + "description": "Contains the information needed to plot wind radius quadrants. Bearing 0–90 = NE quadrant; 90–180 = SE quadrant; 180–270 = SW quadrant; 270–360 = NW quadrant.", + "items": { + "$ref": "#/definitions/RadiusSector" + } + }, + "radiiGeometry": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonGeometry", + "description": "GeoJSON object. Displayed when radiiGeometry=true in request. Describes the outline of the wind radius quadrants." + } + } + }, + "RadiusSector": { + "type": "object", + "description": "Bearing 0–90 = NE quadrant; 90–180 = SE quadrant; 180–270 = SW quadrant; 270–360 = NW quadrant.", + "properties": { + "beginBearing": { + "type": "number", + "format": "double", + "description": "Bearing, in degrees, of the beginning of the quadrant." + }, + "endBearing": { + "type": "number", + "format": "double", + "description": "Bearing, in degrees, of the end of the quadrant." + }, + "range": { + "type": "number", + "format": "double", + "x-ms-client-name": "radius", + "description": "The radius of the quadrant, in nautical miles." + } + } + }, + "StormLocationsResult": { + "type": "object", + "description": "Locations for an individual government-issued storm", + "properties": { + "results": { + "type": "array", + "x-ms-client-name": "stormLocations", + "items": { + "$ref": "#/definitions/StormLocation" + }, + "description": "Locations for an individual government-issued storm" + }, + "nextLink": { + "$ref": "#/definitions/NextLink" + } + } + }, + "StormLocation": { + "type": "object", + "description": "Location for an individual Government-issued storm", + "properties": { + "dateTime": { + "type": "string", + "x-ms-client-name": "timestamp", + "description": "Datetime the forecast is valid, displayed in ISO8601 format." + }, + "location": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPair", + "x-ms-client-name": "coordinates", + "description": "Coordinates of the storm" + }, + "maxWindGust": { + "$ref": "#/definitions/WeatherUnit", + "description": "Maximum wind gust speed associated with the storm. May be NULL." + }, + "sustainedWind": { + "$ref": "#/definitions/WeatherUnit", + "description": "Maximum sustained wind speed associated with the storm. May be NULL." + }, + "minimumPressure": { + "$ref": "#/definitions/WeatherUnit", + "description": "Minimum pressure associated with the storm. May be NULL." + }, + "movement": { + "$ref": "#/definitions/WindDetails", + "description": "The storm movement information." + }, + "status": { + "type": "string", + "description": "Storm status, in English." + }, + "isSubtropical": { + "type": "boolean", + "description": "True when the depression is classified as a subtropical cyclone." + }, + "hasTropicalPotential": { + "type": "boolean", + "description": "True when storm may develop into a Tropical System." + }, + "isPostTropical": { + "type": "boolean", + "description": "True when the storm is weakening away, and will no longer become a tropical system." + }, + "windRadiiSummary": { + "type": "array", + "items": { + "$ref": "#/definitions/StormWindRadiiSummary" + }, + "description": "Displayed when details=true or radiiGeometry=true in the request." + } + } + }, + "AirQualityResult": { + "type": "object", + "description": "This object is returned from a successful Get Air Quality call.", + "properties": { + "results": { + "type": "array", + "x-ms-client-name": "airQualityResults", + "items": { + "$ref": "#/definitions/AirQuality" + }, + "description": "A list of all air quality results for the queried location." + }, + "nextLink": { + "$ref": "#/definitions/NextLink" + } + } + }, + "DailyAirQualityForecastResult": { + "type": "object", + "description": "This object is returned from a successful Get Daily Air Quality Forecast call.", + "properties": { + "results": { + "type": "array", + "x-ms-client-name": "airQualityResults", + "items": { + "$ref": "#/definitions/DailyAirQuality" + }, + "description": "A list of all daily air quality forecasts for the queried location." + }, + "nextLink": { + "$ref": "#/definitions/NextLink" + } + } + }, + "AirQuality": { + "type": "object", + "description": "Information about the air quality in a specific location at a specific time.", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "timestamp", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "index": { + "type": "number", + "format": "float", + "description": "Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See [Wikipedia](https://en.wikipedia.org/wiki/Air_quality_index) for more information." + }, + "globalIndex": { + "type": "number", + "format": "float", + "description": "Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality." + }, + "dominantPollutant": { + "$ref": "#/definitions/DominantPollutant", + "description": "The pollutant with the highest concentration." + }, + "category": { + "type": "string", + "description": "One-word description of the air quality in the requested language. For example, \"Excellent\"." + }, + "categoryColor": { + "type": "string", + "description": "A unique color corresponding to the category of this air quality result." + }, + "description": { + "type": "string", + "description": "A textual explanation of this air quality result in the requested language." + }, + "pollutants": { + "type": "array", + "items": { + "$ref": "#/definitions/Pollutant" + }, + "description": "Information about individual pollutants." + } + } + }, + "DailyAirQuality": { + "type": "object", + "description": "Information about the air quality in a specific location at a specific time.", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "timestamp", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "index": { + "type": "number", + "format": "float", + "description": "Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See [Wikipedia](https://en.wikipedia.org/wiki/Air_quality_index) for more information." + }, + "globalIndex": { + "type": "number", + "format": "float", + "description": "Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality." + }, + "dominantPollutant": { + "$ref": "#/definitions/DominantPollutant", + "description": "The pollutant with the highest concentration." + }, + "category": { + "type": "string", + "description": "One-word description of the air quality in the requested language. For example, \"Excellent\"." + }, + "categoryColor": { + "type": "string", + "description": "A unique color corresponding to the category of this air quality result." + }, + "description": { + "type": "string", + "description": "A textual explanation of this air quality result in the requested language." + } + } + }, + "Pollutant": { + "type": "object", + "description": "Detailed information about an individual pollutant. Not returned if `pollutants`=false.", + "properties": { + "type": { + "$ref": "#/definitions/PollutantType", + "description": "Type of pollutant. Please note that more may be added at any time." + }, + "name": { + "type": "string", + "description": "The name of the pollutant in English." + }, + "index": { + "type": "number", + "format": "float", + "description": "Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See [Wikipedia](https://en.wikipedia.org/wiki/Air_quality_index) for more information." + }, + "globalIndex": { + "type": "number", + "format": "float", + "description": "Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality." + }, + "concentration": { + "$ref": "#/definitions/WeatherUnit", + "description": "An object containing the number of pollutant particles per volume of air." + } + } + }, + "PollutantType": { + "type": "string", + "description": "Type of pollutant. Please note that more may be added at any time.", + "enum": [ + "CO", + "NO2", + "O3", + "PM2.5", + "PM10", + "SO2" + ], + "x-ms-enum": { + "name": "PollutantType", + "modelAsString": true, + "values": [ + { + "value": "CO", + "description": "Carbon monoxide (\"CO\")" + }, + { + "value": "NO2", + "description": "Nitrogen dioxide (\"NO2\")" + }, + { + "value": "O3", + "description": "Ozone (\"O3\")" + }, + { + "value": "PM2.5", + "description": "Particulate matter 2.5 (\"PM2.5\")" + }, + { + "value": "PM10", + "description": "Particulate matter 10 (\"PM10\")" + }, + { + "value": "SO2", + "description": "Sulfur dioxide (\"SO2\")" + } + ] + } + }, + "DominantPollutant": { + "type": "string", + "description": "Type of pollutant. Please note that more may be added at any time.", + "enum": [ + "Carbon Monoxide", + "Nitrogen Dioxide", + "Ozone", + "Particulate Matter 2.5", + "Particulate Matter 10", + "Sulfur Dioxide" + ], + "x-ms-enum": { + "name": "DominantPollutant", + "modelAsString": true, + "values": [ + { + "value": "Carbon Monoxide", + "description": "Carbon monoxide (\"CO\")" + }, + { + "value": "Nitrogen Dioxide", + "description": "Nitrogen dioxide (\"NO2\")" + }, + { + "value": "Ozone", + "description": "Ozone (\"O3\")" + }, + { + "value": "Particulate Matter 2.5", + "description": "Particulate matter 2.5 (\"PM2.5\")" + }, + { + "value": "Particulate Matter 10", + "description": "Particulate matter 10 (\"PM10\")" + }, + { + "value": "Sulfur Dioxide", + "description": "Sulfur dioxide (\"SO2\")" + } + ] + } + }, + "DailyHistoricalActualsResult": { + "type": "object", + "properties": { + "results": { + "type": "array", + "description": "Historical actuals for each requested day.", + "x-ms-client-name": "historicalActuals", + "items": { + "$ref": "#/definitions/DailyHistoricalActuals" + } + }, + "nextLink": { + "$ref": "#/definitions/NextLink" + } + } + }, + "DailyHistoricalActuals": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "timestamp", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnitMaxMinAvg", + "description": "Temperature values." + }, + "degreeDaySummary": { + "$ref": "#/definitions/DegreeDaySummary", + "description": "Summary of heating or cooling degree day information. Degree days are measures of how cold or warm a location is. A degree day compares the mean (the average of the high and low) outdoor temperatures recorded for a location to a standard temperature of 65 degrees F/ 18 degree C." + }, + "precipitation": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen." + }, + "snowfall": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of snow that has fallen." + }, + "snowDepth": { + "$ref": "#/definitions/WeatherUnit", + "description": "Snow depth." + } + } + }, + "DailyHistoricalRecordsResult": { + "type": "object", + "properties": { + "results": { + "type": "array", + "description": "Historical records for each requested day.", + "x-ms-client-name": "historicalRecords", + "items": { + "$ref": "#/definitions/DailyHistoricalRecords" + } + }, + "nextLink": { + "$ref": "#/definitions/NextLink" + } + } + }, + "DailyHistoricalRecords": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "timestamp", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnitYearMaxMinAvg", + "description": "Temperature value." + }, + "precipitation": { + "$ref": "#/definitions/WeatherUnitYearMax", + "description": "Maximum amount of precipitation (liquid equivalent) that has fallen." + }, + "snowfall": { + "$ref": "#/definitions/WeatherUnitYearMax", + "description": "Maximum snowfall." + } + } + }, + "DailyHistoricalNormalsResult": { + "type": "object", + "properties": { + "results": { + "type": "array", + "description": "Historical normals for each requested day.", + "x-ms-client-name": "historicalNormals", + "items": { + "$ref": "#/definitions/DailyHistoricalNormals" + } + }, + "nextLink": { + "$ref": "#/definitions/NextLink" + } + } + }, + "DailyHistoricalNormals": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "timestamp", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnitMaxMinAvg", + "description": "Temperature values." + }, + "degreeDaySummary": { + "$ref": "#/definitions/DegreeDaySummary", + "description": "Summary of heating or cooling degree day information" + }, + "precipitation": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen." + } + } + }, + "WeatherUnitMaxMinAvg": { + "type": "object", + "description": "Returned temperature values.", + "x-ms-client-name": "WeatherValueMaxMinAvg", + "properties": { + "maximum": { + "$ref": "#/definitions/WeatherUnit", + "description": "Maximum temperature for the time period." + }, + "minimum": { + "$ref": "#/definitions/WeatherUnit", + "description": "Minimum temperature for the time period." + }, + "average": { + "$ref": "#/definitions/WeatherUnit", + "description": "Average temperature for the time period." + } + } + }, + "WeatherUnitYearMax": { + "type": "object", + "description": "Returned temperature values.", + "x-ms-client-name": "WeatherValueYearMax", + "properties": { + "maximum": { + "$ref": "#/definitions/WeatherUnitYear", + "description": "Maximum temperature for the time period." + } + } + }, + "WeatherUnitYearMaxMinAvg": { + "type": "object", + "description": "Returned temperature values.", + "x-ms-client-name": "WeatherValueYearMaxMinAvg", + "properties": { + "maximum": { + "$ref": "#/definitions/WeatherUnitYear", + "description": "Maximum temperature for the time period." + }, + "minimum": { + "$ref": "#/definitions/WeatherUnitYear", + "description": "Minimum temperature for the time period." + }, + "average": { + "$ref": "#/definitions/WeatherUnit", + "description": "Average temperature for the time period." + } + } + }, + "WeatherUnitYear": { + "type": "object", + "x-ms-client-name": "WeatherValueYear", + "properties": { + "value": { + "type": "number", + "format": "float", + "description": "Rounded value." + }, + "unit": { + "type": "string", + "description": "Type of unit for the returned value." + }, + "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." + }, + "year": { + "type": "integer", + "format": "int32", + "description": "Year the value occurred." + } + } + }, + "NextLink": { + "type": "string", + "description": "The is the link to the next page of the features returned. If it's the last page, no this field." + } + } +}