Weather - Get Weather Along Route
Gebruik dit om een locatie-nauwkeurige, actuele prognose te krijgen, met inbegrip van gevarenbeoordelingen voor het weer en meldingen langs een route.
De Get Weather Along Route
API is een HTTP-aanvraag GET
die hyperlokal (één kilometer of minder), actuele weers-nowcasts, weersrisicobeoordelingen en meldingen retourneert langs een route die wordt beschreven als een reeks waypoints.
Dit omvat een lijst met weersgevaren die van invloed zijn op het waypoint of de route, en de geaggregeerde gevarenindex voor elk waypoint kan worden gebruikt om elk deel van een route te schilderen op basis van hoe veilig het is voor de bestuurder. Bij het indienen van de waypoints wordt aanbevolen om binnen of dicht bij de afstand te blijven die binnen 120 minuten of kort daarna kan worden afgelegd. De gegevens worden elke vijf minuten bijgewerkt.
De service is een aanvulling op de Azure Maps Route-service waarmee u eerst een route tussen een oorsprong en een bestemming kunt aanvragen en deze kunt gebruiken als invoer voor het weer langs route-eindpunt.
Daarnaast ondersteunt de service scenario's voor het genereren van weermeldingen voor waypoints die een toename van de intensiteit van een weerrisico ervaren. Als bijvoorbeeld wordt verwacht dat het voertuig zware regen gaat ervaren wanneer het een waypoint bereikt, wordt er een weermelding voor zware regen gegenereerd voor dat waypoint, zodat het eindproduct een melding over zware regen kan weergeven voordat de bestuurder dat waypoint bereikt. De trigger voor het weergeven van de melding voor een waypoint kan bijvoorbeeld zijn gebaseerd op een geofence of selecteerbare afstand tot het waypoint.
De API heeft betrekking op alle regio's van de planeet, met uitzondering van de breedtegraden boven Groenland en Antarctica.
GET https://atlas.microsoft.com/weather/route/json?api-version=1.1&query={query}
GET https://atlas.microsoft.com/weather/route/json?api-version=1.1&query={query}&language={language}
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
format
|
path | True |
Gewenste indeling van het antwoord. Alleen |
|
api-version
|
query | True |
string |
Versienummer van Azure Maps-API. |
query
|
query | True |
string |
Coördinaten waarmee de route wordt berekend, gescheiden door dubbele punt (:) en ingevoerd in chronologische volgorde. Er zijn minimaal twee waypoints vereist. Eén API-aanroep kan maximaal 60 waypoints bevatten. Een waypoint geeft de locatie, ETA en optionele kop aan: breedtegraad,lengtegraad,ETA,kop, waarbij
Het wordt aanbevolen om binnen of dicht bij de afstand te blijven die binnen 120 minuten of kort daarna kan worden afgelegd. Op deze manier kan een nauwkeurigere evaluatie worden geboden voor de reis en voorkomen dat geïsoleerde gebeurtenissen niet worden vastgelegd tussen waypoints. Informatie kan en moet langs de route worden bijgewerkt (met name voor ritten langer dan 2 uur) om continu nieuwe waypoints op te halen, maar ook om ervoor te zorgen dat prognosegegevens voor inhoud zoals neerslagtype en intensiteit nauwkeurig zijn naarmate stormen zich ontwikkelen en in de loop van de tijd verdwijnen. |
language
|
query |
string |
Taal waarin zoekresultaten moeten worden geretourneerd. Moet een van de ondersteunde IETF-taaltags zijn, niet hoofdlettergevoelig. Wanneer gegevens in de opgegeven taal niet beschikbaar zijn voor een specifiek veld, wordt de standaardtaal gebruikt. Raadpleeg Ondersteunde talen voor meer informatie. |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
x-ms-client-id |
string |
Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps-beheervlak Account-API. Als u Microsoft Entra ID-beveiliging in Azure Maps wilt gebruiken, raadpleegt u de volgende artikelen voor hulp. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Er is een onverwachte fout opgetreden. |
Beveiliging
AADToken
Dit zijn de Microsoft Entra OAuth 2.0-stromen . Wanneer het wordt gekoppeld met op rollen gebaseerd toegangsbeheer van Azure , kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps-resourceaccounts of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.
Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.
Notities
- Voor deze beveiligingsdefinitie is het gebruik van de
x-ms-client-id
header vereist om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API .
De Authorization URL
is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties.
* Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
* Gebruik van de Azure Maps Web SDK maakt het mogelijk om een toepassing op basis van configuraties in te stellen voor meerdere gebruiksvoorbeelden.
- Zie Overzicht van Microsoft Identity Platform voor meer informatie over Microsoft Identity Platform.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account maakt in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.
Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.
Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.
Type:
apiKey
In:
query
SAS Token
Dit is een Shared Access Signature-token dat is gemaakt op basis van de SAS-bewerking List op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.
Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.
Type:
apiKey
In:
header
Voorbeelden
Successfully retrieve detailed weather casts along a route described as a sequence of waypoints
Voorbeeldaanvraag
GET https://atlas.microsoft.com/weather/route/json?api-version=1.1&query=38.907,-77.037,0:38.907,-77.009,10:38.926,-76.928,20:39.033,-76.852,30:39.168,-76.732,40:39.269,-76.634,50:39.287,-76.612,60
Voorbeeldrespons
{
"summary": {
"iconCode": 35,
"hazards": {
"maxHazardIndex": 0
}
},
"waypoints": [
{
"iconCode": 38,
"shortPhrase": "Mostly cloudy",
"isDayTime": false,
"cloudCover": 70,
"temperature": {
"value": 3.4,
"unit": "C",
"unitType": 17
},
"wind": {
"direction": {
"degrees": 142
},
"speed": {
"value": 2,
"unit": "km/h",
"unitType": 7
}
},
"windGust": {
"speed": {
"value": 3,
"unit": "km/h",
"unitType": 7
}
},
"precipitation": {
"dbz": 0,
"type": "SNOW"
},
"lightningCount": 0,
"sunGlare": {
"calculatedVehicleHeading": 90,
"glareIndex": 0
},
"hazards": {
"maxHazardIndex": 0
},
"notifications": []
},
{
"iconCode": 38,
"shortPhrase": "Mostly cloudy",
"isDayTime": false,
"cloudCover": 65,
"temperature": {
"value": 3.4,
"unit": "C",
"unitType": 17
},
"wind": {
"direction": {
"degrees": 166
},
"speed": {
"value": 1,
"unit": "km/h",
"unitType": 7
}
},
"windGust": {
"speed": {
"value": 2,
"unit": "km/h",
"unitType": 7
}
},
"precipitation": {
"dbz": 0,
"type": "SNOW"
},
"lightningCount": 0,
"sunGlare": {
"calculatedVehicleHeading": 77,
"glareIndex": 0
},
"hazards": {
"maxHazardIndex": 0
},
"notifications": []
},
{
"iconCode": 35,
"shortPhrase": "Partly cloudy",
"isDayTime": false,
"cloudCover": 43,
"temperature": {
"value": 3.2,
"unit": "C",
"unitType": 17
},
"wind": {
"direction": {
"degrees": 163
},
"speed": {
"value": 2,
"unit": "km/h",
"unitType": 7
}
},
"windGust": {
"speed": {
"value": 2,
"unit": "km/h",
"unitType": 7
}
},
"precipitation": {
"dbz": 0,
"type": "SNOW"
},
"lightningCount": 0,
"sunGlare": {
"calculatedVehicleHeading": 44,
"glareIndex": 0
},
"hazards": {
"maxHazardIndex": 0
},
"notifications": []
},
{
"iconCode": 35,
"shortPhrase": "Partly cloudy",
"isDayTime": false,
"cloudCover": 34,
"temperature": {
"value": 1.6,
"unit": "C",
"unitType": 17
},
"wind": {
"direction": {
"degrees": 189
},
"speed": {
"value": 2,
"unit": "km/h",
"unitType": 7
}
},
"windGust": {
"speed": {
"value": 4,
"unit": "km/h",
"unitType": 7
}
},
"precipitation": {
"dbz": 0,
"type": "SNOW"
},
"lightningCount": 0,
"sunGlare": {
"calculatedVehicleHeading": 32,
"glareIndex": 0
},
"hazards": {
"maxHazardIndex": 0
},
"notifications": []
},
{
"iconCode": 38,
"shortPhrase": "Mostly cloudy",
"isDayTime": false,
"cloudCover": 54,
"temperature": {
"value": 0.5,
"unit": "C",
"unitType": 17
},
"wind": {
"direction": {
"degrees": 202
},
"speed": {
"value": 4,
"unit": "km/h",
"unitType": 7
}
},
"windGust": {
"speed": {
"value": 5,
"unit": "km/h",
"unitType": 7
}
},
"precipitation": {
"dbz": 0,
"type": "SNOW"
},
"lightningCount": 0,
"sunGlare": {
"calculatedVehicleHeading": 36,
"glareIndex": 0
},
"hazards": {
"maxHazardIndex": 0
},
"notifications": []
},
{
"iconCode": 35,
"shortPhrase": "Partly cloudy",
"isDayTime": false,
"cloudCover": 46,
"temperature": {
"value": 2.4,
"unit": "C",
"unitType": 17
},
"wind": {
"direction": {
"degrees": 222
},
"speed": {
"value": 4,
"unit": "km/h",
"unitType": 7
}
},
"windGust": {
"speed": {
"value": 5,
"unit": "km/h",
"unitType": 7
}
},
"precipitation": {
"dbz": 0,
"type": "SNOW"
},
"lightningCount": 0,
"sunGlare": {
"calculatedVehicleHeading": 38,
"glareIndex": 0
},
"hazards": {
"maxHazardIndex": 0
},
"notifications": []
},
{
"iconCode": 35,
"shortPhrase": "Partly cloudy",
"isDayTime": false,
"cloudCover": 39,
"temperature": {
"value": 2.3,
"unit": "C",
"unitType": 17
},
"wind": {
"direction": {
"degrees": 231
},
"speed": {
"value": 4,
"unit": "km/h",
"unitType": 7
}
},
"windGust": {
"speed": {
"value": 5,
"unit": "km/h",
"unitType": 7
}
},
"precipitation": {
"dbz": 0,
"type": "SNOW"
},
"lightningCount": 0,
"sunGlare": {
"calculatedVehicleHeading": 43,
"glareIndex": 0
},
"hazards": {
"maxHazardIndex": 0
},
"notifications": []
}
]
}
Definities
Name | Description |
---|---|
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
De foutdetails. |
Error |
Foutreactie |
Hazard |
|
Hazard |
Een ernst-/gevaarsindex.
|
Icon |
Een numerieke waarde die een afbeelding weergeeft waarin de |
Json |
Gewenste indeling van het antwoord. Alleen |
Sun |
Een classificatie die aangeeft hoe verblindend de zon is voor de bestuurder. |
Unit |
Numerieke id-waarde die is gekoppeld aan het type eenheid dat wordt weergegeven. Kan worden gebruikt voor eenheidsvertaling. Raadpleeg Weerservices in Azure Maps voor meer informatie. |
Weather |
Neerslagvoorspelling van het weer langs de route. |
Weather |
Dit object wordt geretourneerd na een geslaagde Weer langs route. |
Weather |
Korte samenvatting van het weer langs de route. |
Weather |
Beschrijving van het weersgevaar dat van invloed is op de reis. |
Weather |
|
Weather |
Specifieke waarde van een bepaalde eenheid met betrekking tot het weer. |
Weather |
|
Wind |
Winddetails die worden geretourneerd, inclusief snelheid en richting. |
Wind |
Windrichting |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
Name | Type | Description |
---|---|---|
info |
object |
De aanvullende informatie. |
type |
string |
Het type aanvullende informatie. |
ErrorDetail
De foutdetails.
Name | Type | Description |
---|---|---|
additionalInfo |
Aanvullende informatie over de fout. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
HazardDetail
Name | Type | Description |
---|---|---|
hazardCode |
string |
Een unieke id (niet-zichtbaar) voor elk type gevaar: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindHv, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning. |
hazardIndex |
Een ernst-/gevaarsindex.
|
|
shortPhrase |
string |
Een weer te geven korte zin die de voorspelde omstandigheden en neerslagintensiteit/-type beschrijft. |
HazardIndex
Een ernst-/gevaarsindex.
-
0
- Geen gevaar. -
1
- Wees op de hoogte, let op. -
2
- Let op, wees voorbereid. -
3
- Actie ondernemen. -
4
- Levensbedreigend, noodgeval.
Name | Type | Description |
---|---|---|
0 |
Integer |
|
1 |
Integer |
|
2 |
Integer |
|
3 |
Integer |
|
4 |
Integer |
IconCode
Een numerieke waarde die een afbeelding weergeeft waarin de iconPhrase
wordt weergegeven. Raadpleeg Weerservices in Azure Maps voor meer informatie.
Name | Type | Description |
---|---|---|
1 |
Integer |
|
10 |
Integer |
|
11 |
Integer |
|
12 |
Integer |
|
13 |
Integer |
|
14 |
Integer |
|
15 |
Integer |
|
16 |
Integer |
|
17 |
Integer |
|
18 |
Integer |
|
19 |
Integer |
|
2 |
Integer |
|
20 |
Integer |
|
21 |
Integer |
|
22 |
Integer |
|
23 |
Integer |
|
24 |
Integer |
|
25 |
Integer |
|
26 |
Integer |
|
27 |
Integer |
|
28 |
Integer |
|
29 |
Integer |
|
3 |
Integer |
|
30 |
Integer |
|
31 |
Integer |
|
32 |
Integer |
|
33 |
Integer |
|
34 |
Integer |
|
35 |
Integer |
|
36 |
Integer |
|
37 |
Integer |
|
38 |
Integer |
|
39 |
Integer |
|
4 |
Integer |
|
40 |
Integer |
|
41 |
Integer |
|
42 |
Integer |
|
43 |
Integer |
|
44 |
Integer |
|
5 |
Integer |
|
6 |
Integer |
|
7 |
Integer |
|
8 |
Integer |
|
9 |
Integer |
JsonFormat
Gewenste indeling van het antwoord. Alleen json
de indeling wordt ondersteund.
Name | Type | Description |
---|---|---|
json |
string |
SunGlare
Een classificatie die aangeeft hoe verblindend de zon is voor de bestuurder.
Name | Type | Description |
---|---|---|
calculatedVehicleHeading |
integer |
Als de waarde van de voertuigkop niet is opgegeven voor een waypoint, berekent de service een kop op basis van de locatie van naburige waypoints, indien opgegeven. |
glareIndex |
integer |
Een index van 0 tot 100 die de schitteringsintensiteit van de zon voor een bestuurder aangeeft. Een waarde van 50 en hoger kan worden beschouwd als een gevaar voor sommige bestuurders en een waarde van 100 geeft aan dat de bestuurder recht in de zon rijdt en de atmosferische omstandigheden duidelijk zijn, waardoor de volledige intensiteit van de zon de bestuurder kan verblinden. |
UnitType
Numerieke id-waarde die is gekoppeld aan het type eenheid dat wordt weergegeven. Kan worden gebruikt voor eenheidsvertaling. Raadpleeg Weerservices in Azure Maps voor meer informatie.
Name | Type | Description |
---|---|---|
0 |
Integer |
|
1 |
Integer |
|
10 |
Integer |
|
11 |
Integer |
|
12 |
Integer |
|
13 |
Integer |
|
14 |
Integer |
|
15 |
Integer |
|
16 |
Integer |
|
17 |
Integer |
|
18 |
Integer |
|
19 |
Integer |
|
2 |
Integer |
|
20 |
Integer |
|
21 |
Integer |
|
22 |
Integer |
|
3 |
Integer |
|
31 |
Integer |
|
4 |
Integer |
|
5 |
Integer |
|
6 |
Integer |
|
7 |
Integer |
|
8 |
Integer |
|
9 |
Integer |
WeatherAlongRoutePrecipitation
Neerslagvoorspelling van het weer langs de route.
Name | Type | Description |
---|---|---|
dbz |
number |
De voorspelde neerslagintensiteit in dBZ (decibel ten opzichte van Z) van 0,0 tot 100,0. |
type |
string |
Neerslagtype. Als er neerslag moet optreden, is dit het type: 'REGEN', 'HAGEL', 'SNEEUW', 'ICE' of 'MIX'. |
WeatherAlongRouteResult
Dit object wordt geretourneerd na een geslaagde Weer langs route.
Name | Type | Description |
---|---|---|
summary |
Korte samenvatting van het weer langs de route. |
|
waypoints |
Gegevens voor elk waypoint die worden geretourneerd in dezelfde volgorde die in de aanvraag is opgegeven. |
WeatherAlongRouteSummary
Korte samenvatting van het weer langs de route.
Name | Type | Description |
---|---|---|
hazards |
Beschrijving van het weersgevaar dat van invloed is op de reis. |
|
iconCode |
Een numerieke waarde die een afbeelding weergeeft waarin de |
WeatherHazards
Beschrijving van het weersgevaar dat van invloed is op de reis.
Name | Type | Description |
---|---|---|
hazardDetails |
Details van de weersgevaren die van invloed zijn op de reis. |
|
maxHazardIndex |
Een ernst-/gevaarsindex.
|
WeatherNotification
Name | Type | Description |
---|---|---|
hazardCode |
string |
Een unieke id (niet-zichtbaar) voor elk type gevaar: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindHv, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning. |
hazardIndex |
Een ernst-/gevaarsindex.
|
|
shortPhrase |
string |
Een weer te geven korte zin die de voorspelde omstandigheden en neerslagintensiteit/-type beschrijft. |
type |
string |
Een type melding dat wordt gegenereerd om bestuurders te waarschuwen voor het begin van een gevaar of een toename van de intensiteit van een gevaar. |
WeatherUnit
Specifieke waarde van een bepaalde eenheid met betrekking tot het weer.
Name | Type | Description |
---|---|---|
unit |
string |
Type eenheid voor de geretourneerde waarde. |
unitType |
Numerieke id-waarde die is gekoppeld aan het type eenheid dat wordt weergegeven. Kan worden gebruikt voor eenheidsvertaling. Raadpleeg Weerservices in Azure Maps voor meer informatie. |
|
value |
number |
Afgeronde waarde. |
WeatherWaypoint
Name | Type | Description |
---|---|---|
cloudCover |
integer |
Percentage dat de bewolking vertegenwoordigt. |
hazards |
Beschrijving van het weersgevaar dat van invloed is op de reis. |
|
iconCode |
Een numerieke waarde die een afbeelding weergeeft waarin de |
|
isDayTime |
boolean |
Hiermee wordt het tijdstip van de dag aangegeven. Waar geeft 'dag' aan, 'onwaar' betekent 'nacht'. |
lightningCount |
integer |
Schatting van de intensiteit van onweer op een open schaal. Een waarde van 0 betekent dat er geen onweer is; waarden van 1 en hoger gemiddelde is er een onweer in toenemende intensiteit. |
notifications |
Lijst met meldingen over weersgevaar. |
|
precipitation |
Neerslagvoorspelling van het weer langs de route. |
|
shortPhrase |
string |
Een weer te geven korte zin die de voorspelde omstandigheden en neerslagintensiteit/-type beschrijft. |
sunGlare |
Een classificatie die aangeeft hoe verblindend de zon is voor de bestuurder. |
|
temperature |
Specifieke waarde van een bepaalde eenheid met betrekking tot het weer. |
|
wind |
Winddetails die worden geretourneerd, inclusief snelheid en richting. |
|
windGust |
Winddetails die worden geretourneerd, inclusief snelheid en richting. |
WindDetails
Winddetails die worden geretourneerd, inclusief snelheid en richting.
Name | Type | Description |
---|---|---|
direction |
Windrichting |
|
speed |
Snelheid van de wind in opgegeven eenheid. |
WindDirection
Windrichting
Name | Type | Description |
---|---|---|
degrees |
integer |
Windrichting in Azimuth graden, beginnend bij het ware noorden en doorgaand in rechtsom richting. Noord is 0 graden, Oost is 90 graden, Zuid is 180 graden, West is 270 graden. Mogelijke waarden 0-359. |
localizedDescription |
string |
Richting afkorting in de opgegeven taal. |