swagger: '2.0'
info:
version: 2020-08-01-preview
title: Microsoft Azure AccessControlClient AccessConnector Weather API
schemes:
- https
tags:
- name: Weather
paths:
/weather:
get:
tags:
- Weather
description: Returns a paginated list of weather data.
operationId: microsoftAzureWeatherList
produces:
- application/json
parameters:
- in: query
name: partyId
description: Party ID.
required: true
type: string
- in: query
name: boundaryId
description: Boundary ID.
required: true
type: string
- in: query
name: extensionId
description: ID of the weather extension.
required: true
type: string
pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$
- in: query
name: weatherDataType
description: Type of weather data (forecast/historical).
required: true
type: string
maxLength: 50
minLength: 0
- in: query
name: granularity
description: Granularity of weather data (daily/hourly).
required: true
type: string
maxLength: 50
minLength: 0
- in: query
name: startDateTime
description: 'Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
format: date-time
- in: query
name: endDateTime
description: 'Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
format: date-time
- in: query
name: maxPageSize
description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
type: integer
format: int32
default: 50
maximum: 1000
minimum: 10
- in: query
name: skipToken
description: Skip token for getting next set of results.
type: string
- in: query
name: api-version
description: The requested API version
required: true
type: string
responses:
'200':
description: Success
schema:
$ref: '#/definitions/WeatherDataListResponse'
default:
description: Error
schema:
$ref: '#/definitions/ErrorResponse'
headers:
x-ms-error-code:
type: string
x-ms-client-name: ErrorCode
x-ms-error-response: true
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
Weather_List:
$ref: ./examples/Weather_List.json
summary: Microsoft Azure Get Weather
/weather/delete-data/{jobId}:
get:
tags:
- Weather
description: Get weather data delete job.
operationId: microsoftAzureWeatherGetdatadeletejobdetails
produces:
- application/json
parameters:
- in: path
name: jobId
description: Id of the job.
required: true
type: string
- in: query
name: api-version
description: The requested API version
required: true
type: string
responses:
'200':
description: Success
schema:
$ref: '#/definitions/WeatherDataDeleteJob'
default:
description: Error
schema:
$ref: '#/definitions/ErrorResponse'
headers:
x-ms-error-code:
type: string
x-ms-client-name: ErrorCode
x-ms-error-response: true
x-ms-examples:
Weather_GetDataDeleteJobDetails:
$ref: ./examples/Weather_GetDataDeleteJobDetails.json
summary: Microsoft Azure Get Weather Delete Data Jobid
put:
tags:
- Weather
description: Create a weather data delete job.
operationId: microsoftAzureWeatherCreatedatadeletejob
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: jobId
description: Job Id supplied by end user.
required: true
type: string
- in: query
name: api-version
description: The requested API version
required: true
type: string
- in: body
name: job
description: Job parameters supplied by user.
required: true
schema:
$ref: '#/definitions/WeatherDataDeleteJob'
responses:
'202':
description: Accepted
schema:
$ref: '#/definitions/WeatherDataDeleteJob'
default:
description: Error
schema:
$ref: '#/definitions/ErrorResponse'
headers:
x-ms-error-code:
type: string
x-ms-client-name: ErrorCode
x-ms-error-response: true
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Weather_CreateDataDeleteJob:
$ref: ./examples/Weather_CreateDataDeleteJob.json
summary: Microsoft Azure Put Weather Delete Data Jobid
/weather/ingest-data/{jobId}:
get:
tags:
- Weather
description: Get weather ingestion job.
operationId: microsoftAzureWeatherGetdataingestionjobdetails
produces:
- application/json
parameters:
- in: path
name: jobId
description: Id of the job.
required: true
type: string
- in: query
name: api-version
description: The requested API version
required: true
type: string
responses:
'200':
description: Success
schema:
$ref: '#/definitions/WeatherDataIngestionJob'
default:
description: Error
schema:
$ref: '#/definitions/ErrorResponse'
headers:
x-ms-error-code:
type: string
x-ms-client-name: ErrorCode
x-ms-error-response: true
x-ms-examples:
Weather_GetDataIngestionJobDetails:
$ref: ./examples/Weather_GetDataIngestionJobDetails.json
summary: Microsoft Azure Get Weather Ingest Data Jobid
put:
tags:
- Weather
description: Create a weather data ingestion job.
operationId: microsoftAzureWeatherCreatedataingestionjob
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: jobId
description: Job id supplied by user.
required: true
type: string
- in: query
name: api-version
description: The requested API version
required: true
type: string
- in: body
name: job
description: Job parameters supplied by user.
required: true
schema:
$ref: '#/definitions/WeatherDataIngestionJob'
responses:
'202':
description: Accepted
schema:
$ref: '#/definitions/WeatherDataIngestionJob'
default:
description: Error
schema:
$ref: '#/definitions/ErrorResponse'
headers:
x-ms-error-code:
type: string
x-ms-client-name: ErrorCode
x-ms-error-response: true
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Weather_CreateDataIngestionJob:
$ref: ./examples/Weather_CreateDataIngestionJob.json
summary: Microsoft Azure Put Weather Ingest Data Jobid
/weather/forecast/hourly/{format}:
get:
description: '**Get Hourly Forecast**
**Applies to**: S0 and S1 pricing tiers.
Request 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.
In 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: microsoftAzureWeatherGethourlyforecast
x-ms-examples:
HourlyForecast:
$ref: ./examples/GetHourlyForecast.json
parameters:
- $ref: '#/parameters/ClientId'
- $ref: '#/parameters/SubscriptionKey'
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/JsonFormat'
- name: query
description: Coordinates of the location for which hourly forecast information 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
type: string
required: true
- $ref: '#/parameters/WeatherUnit'
- 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."
default: 1
in: query
type: integer
- $ref: '#/parameters/WeatherLanguage'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/HourlyForecastResponse'
'400':
$ref: '#/responses/400'
'401':
$ref: '#/responses/401'
'403':
$ref: '#/responses/403'
'404':
$ref: '#/responses/404'
'500':
$ref: '#/responses/500'
summary: Microsoft Azure Get Weather Forecast Hourly Format
tags:
- Weather
/weather/forecast/minute/{format}:
get:
description: '**Get Minute Forecast**
**Applies to**: S1 pricing tier.
Get 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: microsoftAzureWeatherGetminuteforecast
x-ms-examples:
MinuteForecast:
$ref: ./examples/GetMinuteForecast.json
parameters:
- $ref: '#/parameters/ClientId'
- $ref: '#/parameters/SubscriptionKey'
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/JsonFormat'
- name: query
description: Coordinates of the location for which minute forecast information 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
type: string
required: true
- 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."
default: 1
in: query
type: integer
- $ref: '#/parameters/WeatherLanguage'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/MinuteForecastResponse'
'400':
$ref: '#/responses/400'
'401':
$ref: '#/responses/401'
'403':
$ref: '#/responses/403'
'404':
$ref: '#/responses/404'
'500':
$ref: '#/responses/500'
summary: Microsoft Azure Get Weather Forecast Minute Format
tags:
- Weather
/weather/forecast/quarterDay/{format}:
get:
description: '**Get Quarter-Day Forecast**
**Applies to**: S0 and S1 pricing tiers.
Service 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: microsoftAzureWeatherGetquarterdayforecast
x-ms-examples:
QuarterDayForecast:
$ref: ./examples/GetQuarterDayForecast.json
parameters:
- $ref: '#/parameters/ClientId'
- $ref: '#/parameters/SubscriptionKey'
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/JsonFormat'
- name: query
description: Coordinates of the location for which quarter-day forecast information 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
type: string
required: true
- $ref: '#/parameters/WeatherUnit'
- 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."
default: 1
in: query
type: integer
- $ref: '#/parameters/WeatherLanguage'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/QuarterDayForecastResponse'
'400':
$ref: '#/responses/400'
'401':
$ref: '#/responses/401'
'403':
$ref: '#/responses/403'
'404':
$ref: '#/responses/404'
'500':
$ref: '#/responses/500'
summary: Microsoft Azure Get Weather Forecast Quarterday Format
tags:
- Weather
/weather/currentConditions/{format}:
get:
description: '**Get Current Conditions**
**Applies to**: S0 and S1 pricing tiers.
Get 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: microsoftAzureWeatherGetcurrentconditions
x-ms-examples:
CurrentConditions:
$ref: ./examples/GetCurrentConditions.json
parameters:
- $ref: '#/parameters/ClientId'
- $ref: '#/parameters/SubscriptionKey'
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/JsonFormat'
- name: query
description: Coordinates of the location for which current conditions information 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
type: string
required: true
- $ref: '#/parameters/WeatherUnit'
- 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."
default: 'true'
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."
default: 0
in: query
type: integer
- $ref: '#/parameters/WeatherLanguage'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/CurrentConditionsResponse'
'400':
$ref: '#/responses/400'
'401':
$ref: '#/responses/401'
'403':
$ref: '#/responses/403'
'404':
$ref: '#/responses/404'
'500':
$ref: '#/responses/500'
summary: Microsoft Azure Get Weather Currentconditions Format
tags:
- Weather
/weather/forecast/daily/{format}:
get:
description: '**Get Daily Forecast**
**Applies to**: S0 and S1 pricing tiers.
The 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.
In 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: microsoftAzureWeatherGetdailyforecast
x-ms-examples:
DailyForecast:
$ref: ./examples/GetDailyForecast.json
parameters:
- $ref: '#/parameters/ClientId'
- $ref: '#/parameters/SubscriptionKey'
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/JsonFormat'
- name: query
description: Coordinates of the location for which current conditions information 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
type: string
required: true
- $ref: '#/parameters/WeatherUnit'
- 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."
default: 1
in: query
type: integer
- $ref: '#/parameters/WeatherLanguage'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/DailyForecastResponse'
'400':
$ref: '#/responses/400'
'401':
$ref: '#/responses/401'
'403':
$ref: '#/responses/403'
'404':
$ref: '#/responses/404'
'500':
$ref: '#/responses/500'
summary: Microsoft Azure Get Weather Forecast Daily Format
tags:
- Weather
/weather/route/{format}:
get:
description: '**Get Weather along route**
**Applies to**: S1 pricing tier.
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.
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.
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.
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.
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.
The API covers all regions of the planet except latitudes above Greenland and Antarctica.'
operationId: microsoftAzureWeatherGetweatheralongroute
x-ms-examples:
WeatherAlongRoute:
$ref: ./examples/GetWeatherAlongRoute.json
parameters:
- $ref: '#/parameters/ClientId'
- $ref: '#/parameters/SubscriptionKey'
- $ref: '#/parameters/ApiVersion'
- $ref: '#/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: '#/parameters/WeatherLanguage'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/WeatherAlongRouteResponse'
'400':
$ref: '#/responses/400'
'401':
$ref: '#/responses/401'
'403':
$ref: '#/responses/403'
'404':
$ref: '#/responses/404'
'500':
$ref: '#/responses/500'
summary: Microsoft Azure Get Weather Route Format
tags:
- Weather
/weather/severe/alerts/{format}:
get:
description: '**Get Severe Weather Alerts**
**Applies to**: S0 and S1 pricing tiers.
Severe 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: microsoftAzureWeatherGetsevereweatheralerts
x-ms-examples:
SevereWeatherAlert:
$ref: ./examples/GetSevereWeatherAlerts.json
parameters:
- $ref: '#/parameters/ClientId'
- $ref: '#/parameters/SubscriptionKey'
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/JsonFormat'
- name: query
description: Coordinates of the location for which severe weather alerts are 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
type: string
required: true
- $ref: '#/parameters/WeatherLanguage'
- 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`)."
default: 'true'
in: query
type: string
responses:
'200':
description: OK,
schema:
$ref: '#/definitions/SevereWeatherAlertsResponse'
'400':
$ref: '#/responses/400'
'401':
$ref: '#/responses/401'
'403':
$ref: '#/responses/403'
'404':
$ref: '#/responses/404'
'500':
$ref: '#/responses/500'
summary: Microsoft Azure Get Weather Severe Alerts Format
tags:
- Weather
/weather/indices/daily/{format}:
get:
description: '**Get Daily Indices**
**Applies to**: S0 and S1 pricing tiers.
There 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: microsoftAzureWeatherGetdailyindices
x-ms-examples:
DailyIndices:
$ref: ./examples/GetDailyIndices.json
parameters:
- $ref: '#/parameters/ClientId'
- $ref: '#/parameters/SubscriptionKey'
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/JsonFormat'
- name: query
description: Coordinates of the location for which daily indices are 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
type: string
required: true
- $ref: '#/parameters/WeatherLanguage'
- 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."
default: 1
in: query
type: integer
- name: indexId
description: Numeric index identifier that can be used for restricting returned results to the corresponding index type. Cannot be paired with `indexGroupId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported indices.
in: query
type: integer
- name: indexGroupId
description: Numeric index group identifier that can be used for restricting returned results to the corresponding subset of indices (index group). Cannot be paired with `indexId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index groups.
in: query
type: integer
responses:
'200':
description: OK
schema:
$ref: '#/definitions/DailyIndicesResponse'
'400':
$ref: '#/responses/400'
'401':
$ref: '#/responses/401'
'403':
$ref: '#/responses/403'
'404':
$ref: '#/responses/404'
'500':
$ref: '#/responses/500'
summary: Microsoft Azure Get Weather Indices Daily Format
tags:
- Weather
definitions:
PressureTendency:
type: object
properties:
localizedDescription:
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.
WindSpeed:
type: object
description: Speed of wind in specified unit.
properties:
value:
type: number
format: float
description: Rounded value of the speed.
unit:
type: string
description: Type of unit for the speed 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.
Notification:
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:
type: string
description: A displayable short phrase describing the forecasted conditions and precipitation intensity/type.
WeatherDataListResponse:
description: Paged response contains list of requested objects and a URL link to get the next set of results.
required:
- value
type: object
properties:
value:
description: List of requested objects.
type: array
items:
$ref: '#/definitions/WeatherData'
skipToken:
description: Token used in retrieving the next page. If null, there are no additional pages.
type: string
nextLink:
description: Continuation link (absolute URI) to the next page of results in the list.
type: string
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:
type: string
description: A displayable short phrase describing the forecasted conditions and precipitation intensity/type.
Location:
description: Location model class.
required:
- latitude
- longitude
type: object
properties:
latitude:
format: double
description: Latitude of the location.
maximum: 90
minimum: -90
type: number
longitude:
format: double
description: Longitude of the location.
maximum: 180
minimum: -180
type: number
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:
type: string
description: Short summary phrase. Phrase length is approximately 25 characters.
briefPhrase:
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:
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.
WeatherData:
description: Schema of weather data.
required:
- boundaryId
- dateTime
- extensionId
- extensionVersion
- granularity
- location
- partyId
- weatherDataType
type: object
properties:
partyId:
description: Party ID.
minLength: 1
type: string
boundaryId:
description: Boundary ID.
minLength: 1
type: string
extensionId:
description: ID of the weather extension.
minLength: 1
type: string
location:
$ref: '#/definitions/Location'
dateTime:
format: date-time
description: 'Date-time of the weather data, sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
unitSystemCode:
description: Unit System like US/SI etc.
type: string
extensionVersion:
description: Version of the weather data extension.
minLength: 1
type: string
weatherDataType:
description: Type of weather data (forecast/historical).
minLength: 1
type: string
granularity:
description: Granularity of weather data (daily/hourly).
minLength: 1
type: string
cloudCover:
$ref: '#/definitions/Measure'
dewPoint:
$ref: '#/definitions/Measure'
growingDegreeDay:
$ref: '#/definitions/Measure'
precipitation:
$ref: '#/definitions/Measure'
pressure:
$ref: '#/definitions/Measure'
relativeHumidity:
$ref: '#/definitions/Measure'
soilMoisture:
$ref: '#/definitions/Measure'
soilTemperature:
$ref: '#/definitions/Measure'
temperature:
$ref: '#/definitions/Measure'
visibility:
$ref: '#/definitions/Measure'
wetBulbTemperature:
$ref: '#/definitions/Measure'
windChill:
$ref: '#/definitions/Measure'
windDirection:
$ref: '#/definitions/Measure'
windGust:
$ref: '#/definitions/Measure'
windSpeed:
$ref: '#/definitions/Measure'
id:
description: Weather data ID.
type: string
eTag:
description: The ETag value to implement optimistic concurrency.
type: string
readOnly: true
createdDateTime:
format: date-time
description: 'Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
readOnly: true
example: '2020-12-31T11:10:21Z'
modifiedDateTime:
format: date-time
description: 'Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
readOnly: true
example: '2020-12-31T11:10:21Z'
properties:
description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 250 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported."
type: object
additionalProperties: {}
example:
key1: value1
key2: 123.45
QuarterDayForecastResponse:
type: object
properties:
forecasts:
type: array
description: Forecast data for each quarter in the response.
items:
$ref: '#/definitions/QuarterDayForecast'
QuarterDayForecast:
type: object
properties:
date:
type: string
description: Date and time of the forecast in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00.
effectiveDate:
type: string
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: Quarter
modelAsString: true
values:
- value: 0
description: 7:00 am - 1:00 pm / 7:00- 13:00
- value: 1
description: 1:00 pm - 7:00 pm/ 13:00- 19:00
- value: 2
description: 7:00 pm - 1:00 am/ 19:00 - 01:00
- value: 3
description: 1:00 am - 7:00 am/ 01:00 - 07:00
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.
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/Wind'
description: Wind details being returned including speed and direction.
windGust:
$ref: '#/definitions/Wind'
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:
type: string
description: Specifies the type of precipitation ("rain" "snow" "ice" or "mix"). If dbz = zero, precipitationType is not present in the response.
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
DayOrNight:
type: object
properties:
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.
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:
type: string
description: Specifies the type of precipitation ("rain" "snow" "ice" or "mix"). If dbz = zero, precipitationType is not present in the response.
precipitationIntensity:
type: string
description: Description of the intensity.
shortPhrase:
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/Wind'
description: Wind details being returned including speed and direction.
windGust:
$ref: '#/definitions/Wind'
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.
WeatherUnitRange:
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
WeatherDataIngestionJob:
description: Schema of weather ingestion job.
required:
- boundaryId
- extensionApiInput
- extensionApiName
- extensionId
- partyId
type: object
properties:
boundaryId:
description: The id of the boundary object for which weather data is being fetched.
minLength: 1
type: string
partyId:
description: The id of the party for which weather data is being fetched.
minLength: 1
type: string
extensionId:
description: Id of the extension to be used for the providerInput. eg. DTN.ClearAg.
maxLength: 100
minLength: 2
pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$
type: string
extensionApiName:
description: Extension api name to which request is to be made.
maxLength: 100
minLength: 2
type: string
extensionApiInput:
description: Extension api input dictionary which would be used to feed request query/body/parameter information.
type: object
additionalProperties: {}
extensionDataProviderAppId:
description: App id of the weather data provider.
maxLength: 200
minLength: 2
type: string
extensionDataProviderApiKey:
description: Api key of the weather data provider.
maxLength: 200
minLength: 2
type: string
id:
description: Unique job id.
type: string
readOnly: true
status:
description: "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'."
type: string
readOnly: true
durationInSeconds:
format: double
description: Duration of the job in seconds.
type: number
readOnly: true
message:
description: Status message to capture more details of the job.
type: string
readOnly: true
errorCode:
description: Error Code when job failed.
type: string
readOnly: true
createdDateTime:
format: date-time
description: 'Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
readOnly: true
lastActionDateTime:
format: date-time
description: 'Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
readOnly: true
startTime:
format: date-time
description: 'Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
readOnly: true
endTime:
format: date-time
description: 'Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
readOnly: true
name:
description: Name to identify resource.
maxLength: 100
minLength: 0
type: string
description:
description: Textual description of the resource.
maxLength: 500
minLength: 0
type: string
createdBy:
description: Created by user/tenant id.
type: string
readOnly: true
modifiedBy:
description: Modified by user/tenant id.
type: string
readOnly: true
properties:
description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported."
type: object
additionalProperties: {}
example:
key1: value1
key2: 123.45
MinuteForecastResponse:
type: object
properties:
summary:
$ref: '#/definitions/MinuteForecastSummary'
intervalSummaries:
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.
items:
$ref: '#/definitions/Interval'
InnerError:
description: Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
type: object
properties:
code:
description: Specific error code than was provided by the containing error.
type: string
innererror:
$ref: '#/definitions/InnerError'
AlertArea:
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:
type: string
description: Text summarizing the alert in the returned area.
startTime:
type: string
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
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:
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:
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.
WeatherDataDeleteJob:
description: Schema of weather data delete job.
required:
- boundaryId
- extensionId
- partyId
type: object
properties:
extensionId:
description: Id of the extension to be used for the providerInput. eg. DTN.ClearAg.
maxLength: 100
minLength: 2
pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$
type: string
partyId:
description: The id of the party for which weather data is being fetched.
minLength: 1
type: string
boundaryId:
description: The id of the boundary object for which weather data is being fetched.
minLength: 1
type: string
weatherDataType:
description: 'Type of weather data. Possible values include: ''forecast'' , ''historical''.'
type: string
granularity:
description: 'Granularity of weather data. Possible values include: ''daily'' , ''hourly''.'
type: string
startDateTime:
format: date-time
description: 'Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
endDateTime:
format: date-time
description: 'Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
id:
description: Unique job id.
type: string
readOnly: true
status:
description: "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'."
type: string
readOnly: true
durationInSeconds:
format: double
description: Duration of the job in seconds.
type: number
readOnly: true
message:
description: Status message to capture more details of the job.
type: string
readOnly: true
errorCode:
description: Error Code when job failed.
type: string
readOnly: true
createdDateTime:
format: date-time
description: 'Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
readOnly: true
lastActionDateTime:
format: date-time
description: 'Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
readOnly: true
startTime:
format: date-time
description: 'Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
readOnly: true
endTime:
format: date-time
description: 'Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
type: string
readOnly: true
name:
description: Name to identify resource.
maxLength: 100
minLength: 0
type: string
description:
description: Textual description of the resource.
maxLength: 500
minLength: 0
type: string
createdBy:
description: Created by user/tenant id.
type: string
readOnly: true
modifiedBy:
description: Modified by user/tenant id.
type: string
readOnly: true
properties:
description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported."
type: object
additionalProperties: {}
example:
key1: value1
key2: 123.45
DailyForecastSummary:
type: object
properties:
startDate:
type: string
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
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.
Description:
type: object
description: Description of a severe weather alert.
properties:
localized:
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:
type: string
description: Description of the alert in English (en-US).
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/Description'
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:
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:
type: array
items:
$ref: '#/definitions/AlertArea'
description: Information about the alert specific to the affected area(s).
HourlyForecast:
type: object
properties:
date:
type: string
description: Date and time of the forecast in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00.
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.
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/Wind'
description: Wind details being returned including speed and direction.
windGust:
$ref: '#/definitions/Wind'
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:
$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:
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.
Hazards:
type: object
properties:
maxHazardIndex:
$ref: '#/definitions/HazardIndex'
hazardDetails:
type: array
description: Details of the weather hazards affecting the trip.
items:
$ref: '#/definitions/HazardDetail'
Measure:
description: Schema for storing measurement reading and unit.
type: object
properties:
unit:
description: Data unit.
maxLength: 50
minLength: 1
type: string
value:
format: double
description: Data value.
type: number
Wind:
type: object
description: Wind details being returned including speed and direction.
properties:
direction:
$ref: '#/definitions/WindDirection'
description: Wind direction
speed:
$ref: '#/definitions/WindSpeed'
description: Speed of the wind in specified unit.
ODataErrorResponse:
type: object
description: This response object is returned when an error occurs in the Azure Maps API.
properties:
error:
$ref: '#/definitions/ODataError'
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."
WeatherAlongRouteSummary:
type: object
properties:
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.
hazards:
$ref: '#/definitions/Hazards'
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
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:
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:
type: boolean
description: Describes the direction of the `value` and `categoryValue`. For example, when `ascending`=True, the poorest index value is 0 and the best index value is 10. When `ascending`=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!".
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).
WindDirection:
type: object
properties:
degrees:
type: number
format: float
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:
type: string
description: Direction abbreviation in the specified language.
description: Wind direction
HourlyForecastResponse:
type: object
properties:
forecasts:
type: array
description: Forecast data for each returned hour.
items:
$ref: '#/definitions/HourlyForecast'
Interval:
type: object
properties:
startTime:
type: string
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:
type: number
format: double
description: A unit that represents forecasted precipitation intensity.
shortPhrase:
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/Color'
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/Color'
description: The band color that maps to the precipitation type and threshold. If dbz is zero, not present in the response.
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.
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.
cloudCover:
type: integer
format: int32
description: Percent representing cloud cover.
LocalSource:
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.
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 `alertAreas`, `startTime`, `endTime`, or `class`.'
- value: Update
description: '"Update" - the alert has been updated since its initial issuance.'
Waypoint:
type: object
properties:
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.
shortPhrase:
type: string
description: A displayable short phrase describing the forecasted conditions and precipitation intensity/type.
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/Wind'
windGust:
$ref: '#/definitions/Wind'
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/Hazards'
notifications:
type: array
items:
$ref: '#/definitions/Notification'
Error:
description: An error from the Azure AgPlatform service.
required:
- code
- message
type: object
properties:
code:
description: Server-defined set of error codes.
minLength: 1
type: string
message:
description: Human-readable representation of the error.
minLength: 1
type: string
target:
description: Target of the error.
type: string
details:
description: Array of details about specific errors that led to this reported error.
type: array
items:
$ref: '#/definitions/Error'
innererror:
$ref: '#/definitions/InnerError'
DailyIndicesResponse:
type: object
description: This object is returned from a successful Get Daily Indices call.
properties:
results:
type: array
items:
$ref: '#/definitions/DailyIndex'
description: A list of all daily indices for the queried location.
WeatherUnit:
type: object
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.
ErrorResponse:
description: An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
type: object
properties:
error:
$ref: '#/definitions/Error'
traceId:
description: Unique trace Id.
type: string
WeatherAlongRouteResponse:
type: object
description: This object is returned from a successful Weather Along Route.
properties:
summary:
$ref: '#/definitions/WeatherAlongRouteSummary'
waypoints:
type: array
description: Data for each waypoint returned in the same order as specified in the request.
items:
$ref: '#/definitions/Waypoint'
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.
Color:
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.
CurrentConditionsResponse:
type: object
properties:
results:
type: array
items:
$ref: '#/definitions/CurrentConditions'
SevereWeatherAlertsResponse:
type: object
description: This object is returned from a successful Get Severe Weather Alerts call.
properties:
results:
type: array
items:
$ref: '#/definitions/SevereWeatherAlert'
description: A list of all severe weather alerts for the queried location.
PrecipitationSummary:
type: object
properties:
pastHour:
$ref: '#/definitions/WeatherUnit'
description: The amount of precipitation (liquid equivalent) that has fallen in the past hour.
past3Hours:
$ref: '#/definitions/WeatherUnit'
description: The amount of precipitation (liquid equivalent) that has fallen in the past three hours.
past6Hours:
$ref: '#/definitions/WeatherUnit'
description: The amount of precipitation (liquid equivalent) that has fallen in the past six hours. Contains Metric and Imperial Values.
past9Hours:
$ref: '#/definitions/WeatherUnit'
description: The amount of precipitation (liquid equivalent) that has fallen in the past nine hours.
past12Hours:
$ref: '#/definitions/WeatherUnit'
description: The amount of precipitation (liquid equivalent) that has fallen in the past 12 hours.
past18Hours:
$ref: '#/definitions/WeatherUnit'
description: The amount of precipitation (liquid equivalent) that has fallen in the past 18 hours.
past24Hours:
$ref: '#/definitions/WeatherUnit'
description: The amount of precipitation (liquid equivalent) that has fallen in the past 24 hours.
MinuteForecastSummary:
type: object
properties:
briefPhrase60:
type: string
description: Summary phrase for the next 60 minutes. Phrase length is approximately 60 characters.
shortPhrase:
type: string
description: Short summary phrase for the next 120 minutes. Phrase length is approximately 25 characters.
briefPhrase:
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:
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.
description: Phrase summaries for the entire forecast period.
CurrentConditions:
type: object
properties:
dateTime:
type: string
description: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00.
phrase:
type: string
description: Phrase description of the current weather condition. Displayed in specified language.
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.
hasPrecipitation:
type: boolean
description: Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation.
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/Wind'
description: Wind details being returned including speed and direction.
windGust:
$ref: '#/definitions/Wind'
description: Wind gust. Wind gust is a sudden, brief increase in speed of the wind.
uvIndex:
$ref: '#/definitions/UVIndex'
uvIndexPhrase:
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:
$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.
past24HourTemperatureDeparture:
$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.
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."
AirAndPollen:
type: object
properties:
name:
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:
type: string
description: Only exists for air quality. Examples include ozone and particle pollution.
DailyForecast:
type: object
properties:
date:
type: string
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:
$ref: '#/definitions/DegreeDaySummary'
description: Summary of Heating Degree Day or Cooling Degree Day information
airAndPollen:
type: array
items:
$ref: '#/definitions/AirAndPollen'
description: airAndPollen
day:
$ref: '#/definitions/DayOrNight'
description: Day
night:
$ref: '#/definitions/DayOrNight'
description: Night
sources:
type: array
items:
type: string
description: Source(s) of the forecast data.
ODataError:
type: object
description: This object is returned when an error occurs in the Azure Maps API.
properties:
code:
type: string
readOnly: true
description: The ODataError code.
message:
type: string
readOnly: true
description: If available, a human-readable description of the error.
details:
type: array
items:
$ref: '#/definitions/ODataError'
target:
type: string
readOnly: true
description: If available, the target causing the error.
DailyForecastResponse:
type: object
properties:
summary:
$ref: '#/definitions/DailyForecastSummary'
forecasts:
type: array
description: Forecast data for each requested day.
items:
$ref: '#/definitions/DailyForecast'
TemperatureSummary:
type: object
properties:
past6Hours:
type: object
properties:
minimum:
$ref: '#/definitions/WeatherUnit'
description: minimum
maximum:
$ref: '#/definitions/WeatherUnit'
description: maximum
description: Summary of temperature fluctuations over the past 6 hours.
past12Hours:
type: object
properties:
minimum:
$ref: '#/definitions/WeatherUnit'
description: minimum
maximum:
$ref: '#/definitions/WeatherUnit'
description: maximum
description: Summary of temperature fluctuations over the past 12 hours.
past24Hours:
type: object
properties:
minimum:
$ref: '#/definitions/WeatherUnit'
description: minimum
maximum:
$ref: '#/definitions/WeatherUnit'
description: maximum
description: Summary of temperature fluctuations over the past 24 hours.
WeatherAlongRoutePrecipitation:
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."'
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.
parameters:
SubscriptionKey:
name: subscription-key
description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.
type: string
in: query
required: false
x-ms-parameter-location: client
WeatherLanguage:
name: language
description: "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Default value is en-us. \n\nPlease refer to [Supported languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details."
type: string
in: query
required: false
x-ms-parameter-location: method
JsonFormat:
name: format
description: Desired format of the response. Only `json` format is supported.
type: string
in: path
required: true
enum:
- json
x-ms-enum:
name: JsonFormat
modelAsString: true
values:
- value: json
description: '[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)'
x-ms-parameter-location: method
ApiVersion:
name: api-version
description: Version number of Azure Maps API. Current version is 1.0
type: string
in: query
required: true
default: '1.0'
x-ms-parameter-location: client
ClientId:
name: x-ms-client-id
description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
type: string
in: header
required: false
x-ms-parameter-location: client
WeatherUnit:
name: unit
description: Specifies to return the data in either metric units or imperial units. Default value is metric.
default: metric
in: query
type: string
required: false
enum:
- metric
- imperial
x-ms-enum:
name: Unit
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
responses:
'500':
description: An error occurred while processing the request. Please try again later.
schema:
$ref: '#/definitions/ODataErrorResponse'
'404':
description: 'Not Found: the requested resource could not be found, but it may be available again in the future.'
schema:
$ref: '#/definitions/ODataErrorResponse'
'401':
description: Access denied due to invalid subscription key or invalid Microsoft Entra ID bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Microsoft Entra ID bearer token.
schema:
$ref: '#/definitions/ODataErrorResponse'
headers:
WWW-Authenticate:
type: string
description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired"
'400':
description: 'Bad request: one or more parameters were incorrectly specified or are mutually exclusive.'
schema:
$ref: '#/definitions/ODataErrorResponse'
'403':
description: Permission, capacity, or authentication issues.
schema:
$ref: '#/definitions/ODataErrorResponse'
x-ms-parameterized-host:
hostTemplate: '{endpoint}'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/Endpoint'