diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetCurrentAirQuality.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetCurrentAirQuality.json new file mode 100644 index 000000000000..1755b2e1b21d --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetCurrentAirQuality.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": [ + 47.632346, + -122.138874 + ] + }, + "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/preview/1.0/examples/GetCurrentConditions.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetCurrentConditions.json index 20022b386b34..d5b40f433a99 100644 --- a/specification/maps/data-plane/Weather/preview/1.0/examples/GetCurrentConditions.json +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetCurrentConditions.json @@ -2,7 +2,10 @@ "parameters": { "api-version": "1.0", "format": "json", - "query": "47.641268,-122.125679" + "query": [ + 47.641268, + -122.125679 + ] }, "responses": { "200": { diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyAirQuality.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyAirQuality.json new file mode 100644 index 000000000000..6e94faf54622 --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyAirQuality.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": [ + 47.632346, + -122.138874 + ], + "duration": 3 + }, + "responses": { + "200": { + "body": { + "forecasts": [ + { + "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/preview/1.0/examples/GetDailyForecast.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyForecast.json index e1495d3db0eb..5a15f8967809 100644 --- a/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyForecast.json +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyForecast.json @@ -2,7 +2,10 @@ "parameters": { "api-version": "1.0", "format": "json", - "query": "62.6490341,30.0734812", + "query": [ + 62.6490341, + 30.0734812 + ], "duration": 5 }, "responses": { diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyIndices.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyIndices.json index 8b66175a118b..5a20930f2e46 100644 --- a/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyIndices.json +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyIndices.json @@ -2,7 +2,10 @@ "parameters": { "api-version": "1.0", "format": "json", - "query": "43.84745,-79.37849", + "query": [ + 43.84745, + -79.37849 + ], "indexGroupId": 11 }, "responses": { diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetHourlyAirQuality.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetHourlyAirQuality.json new file mode 100644 index 000000000000..85f7bc010626 --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetHourlyAirQuality.json @@ -0,0 +1,943 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": [ + 47.632346, + -122.138874 + ], + "duration": 12 + }, + "responses": { + "200": { + "body": { + "forecasts": [ + { + "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/preview/1.0/examples/GetHourlyForecast.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetHourlyForecast.json index 073b6801a26d..636d70e5fed2 100644 --- a/specification/maps/data-plane/Weather/preview/1.0/examples/GetHourlyForecast.json +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetHourlyForecast.json @@ -2,7 +2,10 @@ "parameters": { "api-version": "1.0", "format": "json", - "query": "47.632346,-122.138874", + "query": [ + 47.632346, + -122.138874 + ], "duration": 12 }, "responses": { diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetMinuteForecast.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetMinuteForecast.json index 54cab45b8247..aab74bb09e96 100644 --- a/specification/maps/data-plane/Weather/preview/1.0/examples/GetMinuteForecast.json +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetMinuteForecast.json @@ -2,7 +2,10 @@ "parameters": { "api-version": "1.0", "format": "json", - "query": "47.632346,-122.138874", + "query": [ + 47.632346, + -122.138874 + ], "interval": 15 }, "responses": { diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetQuarterDayForecast.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetQuarterDayForecast.json index 5e2d732561a9..a0372fc633ac 100644 --- a/specification/maps/data-plane/Weather/preview/1.0/examples/GetQuarterDayForecast.json +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetQuarterDayForecast.json @@ -2,7 +2,10 @@ "parameters": { "api-version": "1.0", "format": "json", - "query": "47.632346,-122.138874", + "query": [ + 47.632346, + -122.138874 + ], "duration": 1 }, "responses": { diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetSevereWeatherAlerts.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetSevereWeatherAlerts.json index 7b5541cfc8c6..cc152eec3cd8 100644 --- a/specification/maps/data-plane/Weather/preview/1.0/examples/GetSevereWeatherAlerts.json +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetSevereWeatherAlerts.json @@ -2,7 +2,10 @@ "parameters": { "api-version": "1.0", "format": "json", - "query": "48.057,-81.091" + "query": [ + 48.057, + -81.091 + ] }, "responses": { "200": { diff --git a/specification/maps/data-plane/Weather/preview/1.0/weather.json b/specification/maps/data-plane/Weather/preview/1.0/weather.json index 1e63f3b770fe..387be470226b 100644 --- a/specification/maps/data-plane/Weather/preview/1.0/weather.json +++ b/specification/maps/data-plane/Weather/preview/1.0/weather.json @@ -50,6 +50,14 @@ ], "responses": {}, "parameters": { + "Pollutants": { + "name": "pollutants", + "in": "query", + "type": "boolean", + "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.", @@ -564,6 +572,223 @@ } } } + }, + "/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" + }, + { + "name": "query", + "description": "Coordinates of the location for which air quality is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "required": true, + "x-ms-client-name": "coordinates", + "x-ms-parameter-location": "method", + "type": "array", + "collectionFormat": "csv", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "number", + "format": "double" + } + }, + { + "$ref": "#/parameters/Pollutants" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CurrentAirQualityResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/airQuality/forecast/daily/{format}": { + "get": { + "description": "**Get Air Quality Daily Forecast**\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_GetAirQualityDailyForecast", + "x-ms-examples": { + "Get Daily Air Quality Forecast": { + "$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" + }, + { + "name": "query", + "description": "Coordinates of the location for which air quality is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "required": true, + "x-ms-client-name": "coordinates", + "x-ms-parameter-location": "method", + "type": "array", + "collectionFormat": "csv", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "number", + "format": "double" + } + }, + { + "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", + "minimum": 1, + "maximum": 7 + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DailyAirQualityForecastResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/airQuality/forecast/hourly/{format}": { + "get": { + "description": "**Get Air Quality Hourly Forecast**\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_GetAirQualityHourlyForecast", + "x-ms-examples": { + "Get Hourly Air Quality Forecast": { + "$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" + }, + { + "name": "query", + "description": "Coordinates of the location for which air quality is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "required": true, + "x-ms-client-name": "coordinates", + "x-ms-parameter-location": "method", + "type": "array", + "collectionFormat": "csv", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "number", + "format": "double" + } + }, + { + "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": [ + { + "value": 1, + "description": "1 Hours" + }, + { + "value": 12, + "description": "12 Hours" + }, + { + "value": 24, + "description": "24 Hours" + }, + { + "value": 48, + "description": "48 Hours" + }, + { + "value": 72, + "description": "72 Hours" + }, + { + "value": 96, + "description": "96 Hours" + } + ] + } + }, + { + "$ref": "#/parameters/Pollutants" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HourlyAirQualityForecastResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } } }, "definitions": { @@ -2482,6 +2707,257 @@ "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!\"." } } + }, + "CurrentAirQualityResponse": { + "type": "object", + "description": "This object is returned from a successful Get Current Air Quality call.", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/AirQuality" + }, + "description": "A list of all air quality results for the queried location." + } + } + }, + "HourlyAirQualityForecastResponse": { + "type": "object", + "description": "This object is returned from a successful Get Hourly Air Quality Forecast call.", + "properties": { + "forecasts": { + "type": "array", + "items": { + "$ref": "#/definitions/AirQuality" + }, + "description": "A list of all hourly air quality forecasts for the queried location." + } + } + }, + "DailyAirQualityForecastResponse": { + "type": "object", + "description": "This object is returned from a successful Get Daily Air Quality Forecast call.", + "properties": { + "forecasts": { + "type": "array", + "items": { + "$ref": "#/definitions/DailyAirQuality" + }, + "description": "A list of all daily air quality forecasts for the queried location." + } + } + }, + "AirQuality": { + "type": "object", + "description": "Information about the air quality in a specific location at a specific time.", + "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." + }, + "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": { + "type": "string", + "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", + "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/Concentration", + "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\")" + } + ] + } + }, + "Concentration": { + "type": "object", + "description": "An object containing the number of pollutant particles per volume of air.", + "properties": { + "value": { + "type": "number", + "format": "float", + "description": "The numerical value indicating the concentration of the corresponding pollutant." + }, + "unit": { + "type": "string", + "description": "Type of unit for the concentration of the pollutant." + }, + "unitType": { + "type": "integer", + "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." + } + } + }, + "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\")" + } + ] + } } } }