Weather - Get Weather Along Route
Används för att få en platsmässigt exakt prognos som är up-tominuten och som innehåller bedömningar av väderrisker och meddelanden längs en rutt.
API:et Get Weather Along Route är en HTTP-begäran GET som returnerar hyperlokala (en kilometer eller mindre), up-toaktuella väderprognoser, bedömningar av väderrisker och meddelanden längs en rutt som beskrivs som en sekvens av waypoints.
Detta inkluderar en lista över väderrisker som påverkar waypointen eller rutten, och det aggregerade riskindexet för varje waypoint 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 tillryggaläggas 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 ökning av intensiteten i en väderrisk. Till exempel, om fordonet förväntas börja uppleva kraftigt regn när det når en waypoint, kommer en väderavisering för kraftigt regn att genereras 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å ett geofence eller ett valbart avstånd till waypointen.
API:et täcker alla regioner på planeten utom breddgrader 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 rutten beräknas, avgränsade med kolon (:) och inmatade i kronologisk ordning. Minst två waypoints krävs. Ett enda API-anrop kan innehålla upp till 60 waypoints. En waypoint anger plats, ETA och valfri rubrik: latitud, longitud, ETA, kurs, där
Det rekommenderas att hålla sig inom, eller nära, det avstånd som kan tillryggaläggas inom 120 minuter eller strax efter. På så sätt kan en mer exakt bedömning ges för resan och förhindra att isolerade händelser inte registreras 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 fram nya waypoints framåt, men också för att säkerställa att prognosinformation för innehåll som nederbördstyp och intensitet är korrekt när stormar utvecklas och försvinner ö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 det konto som är avsett att användas med Microsoft Entra ID-säkerhetsmodellen. Det här unika ID:t för Azure Maps-kontot kan hämtas från Azure Maps konto-API:et för hanteringsplanet. Mer information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i Hantera autentisering i Azure Maps. |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Ett oväntat fel uppstod. |
Säkerhet
AADToken
Det här är Microsoft Entra OAuth 2.0 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll kan den användas för att styra åtkomsten till Azure Maps REST-API:er. 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 Azure Maps REST-API:er.
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 få åtkomstkontroll för specifika API:er och omfång.
Notes
- Den här säkerhetsdefinitionen kräver användningen av
x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hantering-API:et.
Authorization URL är specifik för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer.
* Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan 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 Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.
Med den här nyckeln kan alla program komma åt alla REST API:er. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de har utfärdats i.
För offentligt exponerade program rekommenderar vi att du använder konfidentiella klientprogram metod för åtkomst till Azure Maps REST-API:er 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 sas-åtgärden Lista 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 till 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 mer säkert 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 |
Det aggregerade allvarlighetsgrads-/riskindexet för varje waypoint, som kan användas för att färgkoda ruttsegment för att indikera förarens säkerhet.
|
|
Icon |
Numeriskt värde som representerar en bild som motsvarar det aktuella väderförhållandet som beskrivs av egenskapen |
|
Json |
Önskat format för svaret. Endast |
|
Sun |
Ett betyg som anger hur bländande solen är för föraren. |
|
Unit |
Ett heltal som representerar enhetstypen. Till exempel 17 för Celsius, 18 för Fahrenheit. Kan användas för enhetsöversättning. En fullständig lista 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äderrutt. |
|
Weather |
Kort sammanfattning av vädret längs rutten. |
|
Weather |
Beskrivning av den väderrisk som påverkar resan. |
|
Weather |
|
|
Weather |
Specifikt värde för en viss enhet relaterat till väder. |
|
Weather |
|
|
Wind |
Vindinformation returneras, inklusive hastighet och riktning. |
|
Wind |
Vindriktning |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
| Name | Typ | Description |
|---|---|---|
| info |
object |
Ytterligare information. |
| type |
string |
Ytterligare informationstyp. |
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 (kan inte visas) 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 |
Hazard |
Det aggregerade allvarlighetsgrads-/riskindexet för varje waypoint, som kan användas för att färgkoda ruttsegment för att indikera förarens säkerhet.
|
| shortPhrase |
string |
En visningsbar kort fras som beskriver de prognostiserade förhållandena och nederbördsintensiteten/typen av nederbörd. |
HazardIndex
Det aggregerade allvarlighetsgrads-/riskindexet för varje waypoint, som kan användas för att färgkoda ruttsegment för att indikera förarens säkerhet.
-
0- Ingen fara. -
1- Var informerad, var medveten. -
2- Var uppmärksam, var förberedd. -
3- Vidta åtgärder. -
4- Livshotande, nödsituation.
| Värde | Description |
|---|---|
| 0 |
Ingen fara |
| 1 |
Erfara |
| 2 |
Uppmärksamma |
| 3 |
Vidta åtgärd |
| 4 |
Emergency |
IconCode
Numeriskt värde som representerar en bild som motsvarar det aktuella väderförhållandet som beskrivs av egenskapen Phrase . Mer information finns i Vädertjänster i Azure Maps. Kan vara NULL.
| Värde | Description |
|---|---|
| 1 |
Sunny |
| 2 |
Mestadels soligt |
| 3 |
Delvis soligt |
| 4 |
Tillfälliga moln |
| 5 |
Disigt solsken |
| 6 |
Mestadels molnigt |
| 7 |
Cloudy |
| 8 |
Trist (mulet) |
| 9 | |
| 10 | |
| 11 |
Fog |
| 12 |
Showers |
| 13 |
Mestadels molnigt med duschar |
| 14 |
Delvis soligt med skurar |
| 15 |
Thunderstorms |
| 16 |
Mestadels molnigt med åskväder |
| 17 |
Delvis soligt med åskväder |
| 18 |
Rain |
| 19 |
Flurries |
| 20 |
Mestadels molnigt med flurries |
| 21 |
Delvis soligt med flurries |
| 22 |
Snow |
| 23 |
Mestadels molnigt med snö |
| 24 |
Ice |
| 25 |
Sleet |
| 26 |
Underkylt regn |
| 27 | |
| 28 | |
| 29 |
Regn och snö |
| 30 |
Hot |
| 31 |
Cold |
| 32 |
Windy |
| 33 |
Clear |
| 34 |
Mestadels klart |
| 35 |
Delvis molnigt |
| 36 |
Tillfälliga moln (natt) |
| 37 |
Disigt månsken |
| 38 |
Mestadels molnigt (natt) |
| 39 |
Delvis molnigt med duschar |
| 40 |
Mestadels molnigt med skurar (natt) |
| 41 |
Delvis molnigt med åskväder |
| 42 |
Mestadels molnigt med åska (natt) |
| 43 |
Mestadels molnigt med stormbyar (natt) |
| 44 |
Mestadels molnigt med snö (natt) |
JsonFormat
Önskat format för svaret. Endast json format stöds.
| Värde | Description |
|---|---|
| json |
SunGlare
Ett betyg som anger hur bländande solen är för föraren.
| Name | Typ | Description |
|---|---|---|
| calculatedVehicleHeading |
integer (int32) |
Om fordonets kursvärde inte anges för en waypoint kommer tjänsten att beräkna en rubrik baserat på platsen för intilliggande waypoints om det anges. |
| glareIndex |
integer (int32) |
Ett index från 0 till 100 som anger intensiteten i solbländning för en förare. Ett värde på 50 och högre kan betraktas som en fara för vissa förare och ett värde på 100 betyder att föraren kör rakt in i solen och att de atmosfäriska förhållandena är klara, vilket gör att solens fulla intensitet kan blända föraren. |
UnitType
Ett heltal som representerar enhetstypen. Till exempel 17 för Celsius, 18 för Fahrenheit. Kan användas för enhetsöversättning. En fullständig lista finns i Vädertjänster i Azure Maps.
| Värde | Description |
|---|---|
| 0 |
feet |
| 1 |
inches |
| 2 |
miles |
| 3 |
millimeter |
| 4 |
centimeter |
| 5 |
meter |
| 6 |
kilometer |
| 7 |
kilometersPerHour |
| 8 |
knots |
| 9 |
milesPerHour |
| 10 |
metersPerSecond |
| 11 |
hectoPascals |
| 12 |
inchesOfMercury |
| 13 |
kiloPascals |
| 14 |
millibars |
| 15 |
millimetersOfMercury |
| 16 |
poundsPerSquareInch |
| 17 |
Celsius |
| 18 |
Fahrenheit |
| 19 |
kelvin |
| 20 |
percent |
| 21 |
float |
| 22 |
integer |
| 31 |
MicrogramsPerCubicMeterOfAir |
WeatherAlongRoutePrecipitation
Nederbördsprognos för vädret längs rutten.
| Name | Typ | Description |
|---|---|---|
| dbz |
number (double) |
Den prognostiserade nederbördsintensiteten i dBZ (decibel i förhållande till Z) från 0,0 till 100,0. |
| type |
string |
Typ av nederbörd. Om nederbörd skulle förekomma, vilken typ det kommer att vara: "REGN", "HAGEL", "SNÖ", "IS" eller "BLANDNING". |
WeatherAlongRouteResult
Det här objektet returneras från en lyckad väderrutt.
| Name | Typ | Description |
|---|---|---|
| summary |
Kort sammanfattning av vädret längs rutten. |
|
| waypoints |
Data för varje waypoint som returneras i samma ordning som anges i begäran. |
WeatherAlongRouteSummary
Kort sammanfattning av vädret längs rutten.
| Name | Typ | Description |
|---|---|---|
| hazards |
Beskrivning av den väderrisk som påverkar resan. |
|
| iconCode |
Icon |
Numeriskt värde som representerar en bild som motsvarar det aktuella väderförhållandet som beskrivs av egenskapen |
WeatherHazards
Beskrivning av den väderrisk som påverkar resan.
| Name | Typ | Description |
|---|---|---|
| hazardDetails |
Detaljer om de väderrisker som påverkar resan. |
|
| maxHazardIndex |
Hazard |
Det aggregerade allvarlighetsgrads-/riskindexet för varje waypoint, som kan användas för att färgkoda ruttsegment för att indikera förarens säkerhet.
|
WeatherNotification
| Name | Typ | Description |
|---|---|---|
| hazardCode |
string |
En unik identifierare (kan inte visas) 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 |
Hazard |
Det aggregerade allvarlighetsgrads-/riskindexet för varje waypoint, som kan användas för att färgkoda ruttsegment för att indikera förarens säkerhet.
|
| shortPhrase |
string |
En visningsbar kort fras som beskriver de prognostiserade förhållandena och nederbördsintensiteten/typen av nederbörd. |
| type |
string |
En typ av meddelande som genereras för att varna förare om att en fara börjar eller ökar i intensitet av en fara. |
WeatherUnit
Specifikt värde för en viss enhet relaterat till väder.
| Name | Typ | Description |
|---|---|---|
| unit |
string |
Typ av enhet för det returnerade värdet. |
| unitType |
Unit |
Ett heltal som representerar enhetstypen. Till exempel 17 för Celsius, 18 för Fahrenheit. Kan användas för enhetsöversättning. En fullständig lista finns i Vädertjänster i Azure Maps. |
| value |
number (float) |
Avrundat värde. |
WeatherWaypoint
| Name | Typ | Description |
|---|---|---|
| cloudCover |
integer (int32) |
Procent som representerar molntäcke. |
| hazards |
Beskrivning av den väderrisk som påverkar resan. |
|
| iconCode |
Icon |
Numeriskt värde som representerar en bild som motsvarar det aktuella väderförhållandet som beskrivs av egenskapen |
| isDayTime |
boolean |
Anger tiden på dygnet. Sant anger 'dag',', falskt anger 'natt. |
| lightningCount |
integer (int32) |
Uppskattning av åskintensitet på en öppen skala. Värdet 0 betyder att det inte finns något åskväder. Värdena 1 och högre betyder att det finns ett åskväder i ökande intensitet. |
| notifications |
Lista över meddelanden om väderrisker. |
|
| precipitation |
Nederbördsprognos för vädret längs rutten. |
|
| shortPhrase |
string |
En visningsbar kort fras som beskriver de prognostiserade förhållandena och nederbördsintensiteten/typen av nederbörd. |
| sunGlare |
Ett betyg som anger hur bländande solen är för föraren. |
|
| temperature |
Specifikt värde för en viss enhet relaterat till väder. |
|
| wind |
Vindinformation returneras, inklusive hastighet och riktning. |
|
| windGust |
Vindinformation returneras, inklusive hastighet och riktning. |
WindDetails
Vindinformation returneras, inklusive hastighet och riktning.
| Name | Typ | Description |
|---|---|---|
| direction |
Vindriktning |
|
| speed |
Vindens hastighet i specificerad enhet. |
WindDirection
Vindriktning
| Name | Typ | Description |
|---|---|---|
| degrees |
integer (int32) |
Vindriktning i azimutgrader, med början vid äkta nord och fortsätter medurs. 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. |