Weather - Get Weather Along Route

Använd för att få en platsvis exakt, upp till minuten-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), väder nowcasts (up-to-the-minute), väderutvärderingar och meddelanden längs en väg som beskrivs som en sekvens med vägpunkter. Detta inkluderar en lista över väderrisker som påverkar vägpunkten eller rutten, och det aggregerade faroindexet för varje vägpunkt kan användas för att måla varje del av en väg enligt hur säker den är för föraren. När du skickar in vägpunkterna 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 ökning av intensiteten för en väderrisk. Om fordonet till exempel förväntas börja drabbas av kraftigt regn när det når en vägpunkt genereras en väderavisering för kraftigt regn för den waypointen så att slutprodukten kan visa ett meddelande om kraftigt regn innan föraren når den vägpunkten. Utlösaren för när meddelandet ska visas för en vägpunkt kan till exempel baseras på geofence eller valbart avstånd till vägpunkten.

API:et omfattar alla regioner på planeten förutom 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

JsonFormat

Önskat format för svaret. Endast json format stöds.

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å vägpunkter krävs. Ett enda API-anrop kan innehålla upp till 60 vägpunkter. En vägpunkt anger plats, ETA och valfri rubrik: latitud, longitud, ETA, rubrik, där

  • Latitude – Latitudkoordinat i decimalgrader.
  • Longitude - Longitudkoordinat i decimalgrader.
  • ETA (estimated time of arrival) - Antalet minuter från den aktuella tiden som det tar för fordonet att nå vägpunkten. Tillåtet intervall är från 0,0 till 120,0 minuter.
  • Heading - Ett valfritt värde som anger fordonets rubrik när det passerar vägpunkten. Uttryckt i medurs grader i förhållande till true north. Detta utfärdas för att beräkna solbländning som en körfara. Tillåtet intervall är från 0,0 till 360,0 grader. Om det inte anges härleds en rubrik automatiskt baserat på positionen för närliggande vägpunkter.

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 avleder ö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å det angivna språket 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äkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps hanteringsplans konto-API. 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

WeatherAlongRouteResult

OK

Other Status Codes

ErrorResponse

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 Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto 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 för att 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.

Kommentarer

  • Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API :et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, 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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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 Portal 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:et. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de utfärdas i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, 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 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 återgivningsmissbruk och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

Successfully retrieve detailed weather casts along a route described as a sequence of waypoints

Sample Request

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

Sample Response

{
  "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
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

HazardDetail
HazardIndex

Ett allvarlighets-/faroindex.

  • 0 - Ingen fara.
  • 1 - Var informerad, var medveten.
  • 2 - Var uppmärksam, var beredd.
  • 3 - Vidta åtgärder.
  • 4 - Livshotande, akut.
IconCode

Numeriskt värde som representerar en bild som visar iconPhrase. Mer information finns i Vädertjänster i Azure Maps.

JsonFormat

Önskat format för svaret. Endast json format stöds.

SunGlare

Ett betyg som anger hur bländande solen är för 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.

WeatherAlongRoutePrecipitation

Nederbördsprognos för vädret längs rutten.

WeatherAlongRouteResult

Det här objektet returneras från en lyckad väderrutt.

WeatherAlongRouteSummary

Kort sammanfattning av vädret längs rutten.

WeatherHazards

Beskrivning av den väderrisk som påverkar resan.

WeatherNotification
WeatherUnit

Specifikt värde för en viss enhet som är relaterad till väder.

WeatherWaypoint
WindDetails

Vinddetaljer returneras inklusive hastighet och riktning.

WindDirection

Vindriktning

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

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

HazardIndex

Ett allvarlighets-/faroindex.

  • 0 - Ingen fara.
  • 1 - Var informerad, var medveten.
  • 2 - Var uppmärksam, var beredd.
  • 3 - Vidta åtgärder.
  • 4 - Livshotande, akut.
shortPhrase

string

En kort fras som beskriver prognostiserade förhållanden och nederbördsintensitet/typ.

HazardIndex

Ett allvarlighets-/faroindex.

  • 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

Datautbytesformat för JavaScript-objektnotation

SunGlare

Ett betyg som anger hur bländande solen är för föraren.

Name Typ Description
calculatedVehicleHeading

integer

Om fordonsrubrikvärdet inte anges för en vägpunkt beräknar tjänsten en rubrik baserat på platsen för angränsande vägpunkter om så anges.

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 ett värde på 100 betyder att föraren kör rakt in i solen och atmosfäriska förhållanden är tydliga så att solens fulla intensitet kan bli blind för 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 inträffar ska den typ av nederbörd vara: "RAIN", "HAIL", "SNOW", "ICE" eller "MIX".

WeatherAlongRouteResult

Det här objektet returneras från en lyckad väderrutt.

Name Typ Description
summary

WeatherAlongRouteSummary

Kort sammanfattning av vädret längs rutten.

waypoints

WeatherWaypoint[]

Data för varje vägpunkt som returneras i samma ordning som anges i begäran.

WeatherAlongRouteSummary

Kort sammanfattning av vädret längs rutten.

Name Typ Description
hazards

WeatherHazards

Beskrivning av den väderrisk som påverkar resan.

iconCode

IconCode

Numeriskt värde som representerar en bild som visar iconPhrase. Mer information finns i Vädertjänster i Azure Maps.

WeatherHazards

Beskrivning av den väderrisk som påverkar resan.

Name Typ Description
hazardDetails

HazardDetail[]

Information om de väderrisker som påverkar resan.

maxHazardIndex

HazardIndex

Ett allvarlighets-/faroindex.

  • 0 - Ingen fara.
  • 1 - Var informerad, var medveten.
  • 2 - Var uppmärksam, var beredd.
  • 3 - Vidta åtgärder.
  • 4 - Livshotande, akut.

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

HazardIndex

Ett allvarlighets-/faroindex.

  • 0 - Ingen fara.
  • 1 - Var informerad, var medveten.
  • 2 - Var uppmärksam, var beredd.
  • 3 - Vidta åtgärder.
  • 4 - Livshotande, akut.
shortPhrase

string

En kort fras som beskriver prognostiserade förhållanden och nederbördsintensitet/typ.

type

string

En typ av anmälan som genereras för att varna förare om uppkomsten av en fara, eller ökning av 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

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

WeatherHazards

Beskrivning av den väderrisk som påverkar resan.

iconCode

IconCode

Numeriskt värde som representerar en bild som visar iconPhrase. Mer information finns i Vädertjänster i Azure Maps.

isDayTime

boolean

Anger tid på dagen. True anger "day", false anger "natt".

lightningCount

integer

Uppskattning av åskintensiteten i öppen skala. Värdet 0 innebär att det inte förekommer åska. värden på 1 och högre innebär åska i ökande intensitet.

notifications

WeatherNotification[]

Lista över aviseringar om väderrisker.

precipitation

WeatherAlongRoutePrecipitation

Nederbördsprognos för vädret längs rutten.

shortPhrase

string

En kort fras som beskriver prognostiserade förhållanden och nederbördsintensitet/typ.

sunGlare

SunGlare

Ett betyg som anger hur bländande solen är för föraren.

temperature

WeatherUnit

Specifikt värde för en viss enhet som är relaterad till väder.

wind

WindDetails

Vinddetaljer returneras inklusive hastighet och riktning.

windGust

WindDetails

Vinddetaljer returneras inklusive hastighet och riktning.

WindDetails

Vinddetaljer returneras inklusive hastighet och riktning.

Name Typ Description
direction

WindDirection

Vindriktning

speed

WeatherUnit

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. Nord ä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.