{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Weather API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Weather", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Get Weather", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/weather", "params": [ { "name": "partyId", "value": "", "type": "query", "description": "Party ID." }, { "name": "boundaryId", "value": "", "type": "query", "description": "Boundary ID." }, { "name": "extensionId", "value": "", "type": "query", "description": "ID of the weather extension." }, { "name": "weatherDataType", "value": "", "type": "query", "description": "Type of weather data (forecast/historical)." }, { "name": "granularity", "value": "", "type": "query", "description": "Granularity of weather data (daily/hourly)." }, { "name": "startDateTime", "value": "", "type": "query", "description": "Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ." }, { "name": "endDateTime", "value": "", "type": "query", "description": "Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ." }, { "name": "maxPageSize", "value": "", "type": "query", "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50." }, { "name": "skipToken", "value": "", "type": "query", "description": "Skip token for getting next set of results." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version" } ] }, "docs": "Returns a paginated list of weather data." }, { "info": { "name": "Microsoft Azure Get Weather Delete Data Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/weather/delete-data/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Id of the job." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version" } ] }, "docs": "Get weather data delete job." }, { "info": { "name": "Microsoft Azure Put Weather Delete Data Jobid", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/weather/delete-data/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Job Id supplied by end user." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version" } ] }, "docs": "Create a weather data delete job." }, { "info": { "name": "Microsoft Azure Get Weather Ingest Data Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/weather/ingest-data/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Id of the job." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version" } ] }, "docs": "Get weather ingestion job." }, { "info": { "name": "Microsoft Azure Put Weather Ingest Data Jobid", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/weather/ingest-data/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Job id supplied by user." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version" } ] }, "docs": "Create a weather data ingestion job." }, { "info": { "name": "Microsoft Azure Get Weather Forecast Hourly Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/weather/forecast/hourly/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "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." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "query", "value": "", "type": "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\"." }, { "name": "unit", "value": "", "type": "query", "description": "Specifies to return the data in either metric units or imperial units. Default value is metric." }, { "name": "duration", "value": "", "type": "query", "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." }, { "name": "language", "value": "", "type": "query", "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." } ] }, "docs": "**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 hourl" }, { "info": { "name": "Microsoft Azure Get Weather Forecast Minute Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/weather/forecast/minute/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "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." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "query", "value": "", "type": "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\"." }, { "name": "interval", "value": "", "type": "query", "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." }, { "name": "language", "value": "", "type": "query", "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." } ] }, "docs": "**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)." }, { "info": { "name": "Microsoft Azure Get Weather Forecast Quarterday Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/weather/forecast/quarterDay/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "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." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "query", "value": "", "type": "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\"." }, { "name": "unit", "value": "", "type": "query", "description": "Specifies to return the data in either metric units or imperial units. Default value is metric." }, { "name": "duration", "value": "", "type": "query", "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." }, { "name": "language", "value": "", "type": "query", "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." } ] }, "docs": "**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." }, { "info": { "name": "Microsoft Azure Get Weather Currentconditions Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/weather/currentConditions/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "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." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "query", "value": "", "type": "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\"." }, { "name": "unit", "value": "", "type": "query", "description": "Specifies to return the data in either metric units or imperial units. Default value is metric." }, { "name": "details", "value": "", "type": "query", "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." }, { "name": "duration", "value": "", "type": "query", "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." }, { "name": "language", "value": "", "type": "query", "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." } ] }, "docs": "**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, prec" }, { "info": { "name": "Microsoft Azure Get Weather Forecast Daily Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/weather/forecast/daily/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "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." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "query", "value": "", "type": "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\"." }, { "name": "unit", "value": "", "type": "query", "description": "Specifies to return the data in either metric units or imperial units. Default value is metric." }, { "name": "duration", "value": "", "type": "query", "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." }, { "name": "language", "value": "", "type": "query", "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." } ] }, "docs": "**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 day" }, { "info": { "name": "Microsoft Azure Get Weather Route Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/weather/route/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "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." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "query", "value": "", "type": "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." }, { "name": "language", "value": "", "type": "query", "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." } ] }, "docs": "**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 th" }, { "info": { "name": "Microsoft Azure Get Weather Severe Alerts Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/weather/severe/alerts/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "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." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "query", "value": "", "type": "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\"." }, { "name": "language", "value": "", "type": "query", "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." }, { "name": "details", "value": "", "type": "query", "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`)." } ] }, "docs": "**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 a" }, { "info": { "name": "Microsoft Azure Get Weather Indices Daily Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/weather/indices/daily/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "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." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "query", "value": "", "type": "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\"." }, { "name": "language", "value": "", "type": "query", "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." }, { "name": "duration", "value": "", "type": "query", "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." }, { "name": "indexId", "value": "", "type": "query", "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." }, { "name": "indexGroupId", "value": "", "type": "query", "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." } ] }, "docs": "**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 oth" } ] } ], "bundled": true }