Weather - Get Weather Along Route
Använd för att få en platsmässigt exakt, aktuell prognos som innehåller väderriskbedömningar och aviseringar längs en rutt.
API:et Get Weather Along Route
är en HTTP-begäran GET
som returnerar hyperlokal (en kilometer eller mindre), aktuella väderutsändningar, utvärderingar av väderrisker och meddelanden längs en väg som beskrivs som en sekvens med waypoints.
Detta inkluderar en lista över väderrisker som påverkar vägpunkten eller rutten, och det aggregerade riskindexet för varje vägpunkt kan användas för att måla varje del av en rutt enligt hur säker den är för föraren. När du skickar in waypoints rekommenderar vi att du håller dig inom eller nära det avstånd som kan färdas inom 120 minuter eller strax efter. Data uppdateras var femte minut.
Tjänsten kompletterar Azure Maps Route Service som gör att du först kan begära en väg mellan ett ursprung och ett mål och använda den som indata för Weather Along Route-slutpunkten.
Dessutom stöder tjänsten scenarier för att generera vädermeddelanden för waypoints som upplever en ökad intensitet för en väderrisk. Om fordonet till exempel förväntas börja uppleva kraftigt regn när det når en vägpunkt genereras en väderanmälan för kraftigt regn för den waypointen så att slutprodukten kan visa ett meddelande om kraftigt regn innan föraren når den waypointen. Utlösaren för när meddelandet ska visas för en waypoint kan till exempel baseras på en geofence eller valbart avstånd till vägpunkten.
API:et omfattar alla regioner på planeten utom latituderna ovanför Grönland och Antarktis.
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-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
format
|
path | True |
Önskat format för svaret. Endast |
|
api-version
|
query | True |
string |
Versionsnummer för Azure Maps API. |
query
|
query | True |
string |
Koordinater genom vilka vägen beräknas, avgränsade med kolon (:) och anges i kronologisk ordning. Minst två waypoints krävs. Ett enda API-anrop kan innehålla upp till 60 waypoints. En vägpunkt anger plats, ETA och valfri rubrik: latitud, longitud, ETA,rubrik, där
Vi rekommenderar att du håller dig inom, eller nära, det avstånd som kan färdas inom 120 minuter eller strax efter. På så sätt kan en mer korrekt utvärdering tillhandahållas för resan och förhindra att isolerade händelser inte samlas in mellan waypoints. Information kan och bör uppdateras längs rutten (särskilt för resor som är längre än 2 timmar) för att kontinuerligt dra nya vägpunkter framåt, men också för att säkerställa att prognosinformationen för innehåll som nederbördstyp och intensitet är korrekt när stormar utvecklas och skingras över tid. |
language
|
query |
string |
Språk där sökresultat ska returneras. Bör vara en av IETF-språktaggar som stöds, skiftlägesokänsliga. När data på angivet språk inte är tillgängliga för ett visst fält används standardspråket. Mer information finns i Språk som stöds . |
Begärandehuvud
Name | Obligatorisk | Typ | Description |
---|---|---|---|
x-ms-client-id |
string |
Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID-säkerhetsmodellen. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar . |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Det uppstod ett oväntat fel. |
Säkerhet
AADToken
Det här är Microsoft Entra OAuth 2.0-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till REST-API:er för Azure Maps. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Rest-API:er för Azure Maps.
För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.
Kommentarer
- Den här säkerhetsdefinitionen
x-ms-client-id
kräver att huvudet används för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API :et.
Authorization URL
är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer.
* Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
* Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Det här är en delad nyckel som etableras när du skapar ett Azure Maps-konto i Azure-portalen eller använder PowerShell, CLI, Azure SDK:er eller REST API.
Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som huvudnyckel i det konto som de har utfärdats i.
För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att få åtkomst till REST-API:er för Azure Maps så att din nyckel kan lagras på ett säkert sätt.
Typ:
apiKey
I:
query
SAS Token
Det här är en signaturtoken för delad åtkomst som skapas från åtgärden List SAS på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett säkrare sätt än den delade nyckeln.
För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.
Typ:
apiKey
I:
header
Exempel
Successfully retrieve detailed weather casts along a route described as a sequence of waypoints
Exempelbegäran
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
Exempelsvar
{
"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": []
}
]
}
Definitioner
Name | Description |
---|---|
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Hazard |
|
Hazard |
Ett allvarlighets-/riskindex.
|
Icon |
Numeriskt värde som representerar en bild som visar |
Json |
Önskat format för svaret. Endast |
Sun |
Ett betyg som anger hur bländande solen är för föraren. |
Unit |
Numeriskt ID-värde som är associerat med den typ av enhet som visas. Kan användas för enhetsöversättning. Mer information finns i Vädertjänster i Azure Maps . |
Weather |
Nederbördsprognos för vädret längs rutten. |
Weather |
Det här objektet returneras från en lyckad väderväg längs vägen. |
Weather |
Kort sammanfattning av vädret längs rutten. |
Weather |
Beskrivning av väderrisken som påverkar resan. |
Weather |
|
Weather |
Specifikt värde för en viss enhet som är relaterad till väder. |
Weather |
|
Wind |
Vinddetaljer som returneras inklusive hastighet och riktning. |
Wind |
Vindriktning |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Ytterligare information. |
type |
string |
Den ytterligare informationstypen. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
HazardDetail
Name | Typ | Description |
---|---|---|
hazardCode |
string |
En unik identifierare (ej visningsbar) för varje typ av fara: 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. |
hazardIndex |
Ett allvarlighets-/riskindex.
|
|
shortPhrase |
string |
En visningsbar kort fras som beskriver prognostiserade förhållanden och nederbördsintensitet/typ. |
HazardIndex
Ett allvarlighets-/riskindex.
-
0
- Ingen fara. -
1
- Var informerad, var medveten. -
2
- Var uppmärksam, var beredd. -
3
- Vidta åtgärder. -
4
- Livshotande, akut.
Name | Typ | Description |
---|---|---|
0 |
Integer |
|
1 |
Integer |
|
2 |
Integer |
|
3 |
Integer |
|
4 |
Integer |
IconCode
Numeriskt värde som representerar en bild som visar iconPhrase
. Mer information finns i Vädertjänster i Azure Maps .
Name | Typ | 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
Önskat format för svaret. Endast json
format stöds.
Name | Typ | Description |
---|---|---|
json |
string |
SunGlare
Ett betyg som anger hur bländande solen är för föraren.
Name | Typ | Description |
---|---|---|
calculatedVehicleHeading |
integer |
Om fordonets rubrikvärde inte anges för en vägpunkt beräknar tjänsten en rubrik baserat på platsen för angränsande waypoints om det tillhandahålls. |
glareIndex |
integer |
Ett index från 0 till 100 som anger solbländningsintensitet för en förare. Ett värde på 50 och högre kan betraktas som en fara för vissa förare och värdet 100 betyder att föraren kör rakt in i solen och atmosfäriska förhållanden är tydliga, vilket gör det möjligt för solens fulla intensitet att förblinda föraren. |
UnitType
Numeriskt ID-värde som är associerat med den typ av enhet som visas. Kan användas för enhetsöversättning. Mer information finns i Vädertjänster i Azure Maps .
Name | Typ | 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
Nederbördsprognos för vädret längs rutten.
Name | Typ | Description |
---|---|---|
dbz |
number |
Den prognostiserade nederbördsintensiteten i dBZ (decibel i förhållande till Z) från 0,0 till 100,0. |
type |
string |
Nederbördstyp. Om nederbörden ska inträffa, den typ som den kommer att vara: "RAIN", "HAIL", "SNOW", "ICE" eller "MIX". |
WeatherAlongRouteResult
Det här objektet returneras från en lyckad väderväg längs vägen.
Name | Typ | Description |
---|---|---|
summary |
Kort sammanfattning av vädret längs rutten. |
|
waypoints |
Data för varje waypoint returneras i samma ordning som anges i begäran. |
WeatherAlongRouteSummary
Kort sammanfattning av vädret längs rutten.
Name | Typ | Description |
---|---|---|
hazards |
Beskrivning av väderrisken som påverkar resan. |
|
iconCode |
Numeriskt värde som representerar en bild som visar |
WeatherHazards
Beskrivning av väderrisken som påverkar resan.
Name | Typ | Description |
---|---|---|
hazardDetails |
Information om väderriskerna som påverkar resan. |
|
maxHazardIndex |
Ett allvarlighets-/riskindex.
|
WeatherNotification
Name | Typ | Description |
---|---|---|
hazardCode |
string |
En unik identifierare (ej visningsbar) för varje typ av fara: 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. |
hazardIndex |
Ett allvarlighets-/riskindex.
|
|
shortPhrase |
string |
En visningsbar kort fras som beskriver prognostiserade förhållanden och nederbördsintensitet/typ. |
type |
string |
En typ av meddelande som genereras för att varna för att en fara uppstår eller öka intensiteten i en fara. |
WeatherUnit
Specifikt värde för en viss enhet som är relaterad till väder.
Name | Typ | Description |
---|---|---|
unit |
string |
Typ av enhet för det returnerade värdet. |
unitType |
Numeriskt ID-värde som är associerat med den typ av enhet som visas. Kan användas för enhetsöversättning. Mer information finns i Vädertjänster i Azure Maps . |
|
value |
number |
Avrundat värde. |
WeatherWaypoint
Name | Typ | Description |
---|---|---|
cloudCover |
integer |
Procent som representerar molntäcke. |
hazards |
Beskrivning av väderrisken som påverkar resan. |
|
iconCode |
Numeriskt värde som representerar en bild som visar |
|
isDayTime |
boolean |
Anger tid på dagen. Sant anger "dag", falskt anger "natt". |
lightningCount |
integer |
Uppskattning av åskintensitet i öppen skala. Värdet 0 innebär att det inte förekommer något åskväder. värden på 1 och högre innebär åskväder i ökande intensitet. |
notifications |
Lista över aviseringar om väderrisker. |
|
precipitation |
Nederbördsprognos för vädret längs rutten. |
|
shortPhrase |
string |
En visningsbar kort fras som beskriver prognostiserade förhållanden och nederbördsintensitet/typ. |
sunGlare |
Ett betyg som anger hur bländande solen är för föraren. |
|
temperature |
Specifikt värde för en viss enhet som är relaterad till väder. |
|
wind |
Vinddetaljer som returneras inklusive hastighet och riktning. |
|
windGust |
Vinddetaljer som returneras inklusive hastighet och riktning. |
WindDetails
Vinddetaljer som returneras inklusive hastighet och riktning.
Name | Typ | Description |
---|---|---|
direction |
Vindriktning |
|
speed |
Vindhastighet i angiven enhet. |
WindDirection
Vindriktning
Name | Typ | Description |
---|---|---|
degrees |
integer |
Vindriktning i Azimuth grader, börjar på true North och fortsätter i medurs riktning. Norr är 0 grader, öst är 90 grader, söder är 180 grader, väst är 270 grader. Möjliga värden 0–359. |
localizedDescription |
string |
Riktningsförkortning på det angivna språket. |