Weather - Get Weather Along Route Preview

Zyskaj Pogoda na trasie

Dotyczy: warstwa cenowa S1.

Pogoda w interfejsie API trasy zwraca funkcję Hyper Local (co najmniej jedną Kilometer), nowcasts Pogoda na minutę, ocenę zagrożeń pogodowych i powiadomienia w trasie opisanej jako sekwencja waypoints. Obejmuje to listę zagrożeń pogodowych wpływających na punkt nawigacyjny lub trasę, a zagregowany indeks ryzyka dla każdego punkt nawigacyjnyu może być używany do malowania każdej części trasy zgodnie z jej bezpieczeństwem. W przypadku przesyłania waypoints zaleca się pozostawanie w obrębie lub w bliskiej odległości, która może być przenoszona w ciągu 120 minut lub wkrótce. Dane są aktualizowane co pięć minut.

Usługa uzupełnia Azure Maps Route Service , która pozwala na pierwsze żądanie trasy między źródłem a miejscem docelowym i używa tego jako danych wejściowych dla pogody w punkcie końcowym trasy.

Ponadto usługa obsługuje scenariusze generowania powiadomień pogodowych dla waypoints, które napotykają wzrost intensywności pogodowej. Na przykład, jeśli oczekuje się, że pojazd osiągnie bardzo duży wpływ na punkt nawigacyjny, zostanie wygenerowane powiadomienie pogodowe o dużym deszczu dla tego punkt nawigacyjny, dzięki czemu produkt końcowy będzie wyświetlał duże powiadomienie o deszczu, zanim sterownik osiągnie ten punkt nawigacyjny. Wyzwalacz, dla którego ma być wyświetlane powiadomienie dla elementu punkt nawigacyjny, może być oparty na na przykład na geoogrodzeniulub z wybraną odległością do punkt nawigacyjny.

Interfejs API obejmuje wszystkie regiony globalnej z wyjątkiem Latitudes wyższych niż Grenlandia i Antarktyda.

GET https://atlas.microsoft.com/weather/route/json?api-version=1.0&query={query}
GET https://atlas.microsoft.com/weather/route/json?subscription-key={subscription-key}&api-version=1.0&query={query}&language={language}

Parametry identyfikatora URI

Name In Required Type Description
format
path True

Żądany format odpowiedzi. jsonObsługiwany jest tylko format.

api-version
query True
  • string

Numer wersji interfejsu API Azure Maps. Bieżąca wersja to 1,0

query
query True
  • string

Współrzędne, w których jest obliczana trasa, oddzielone dwukropkiem (:) i wprowadzone w kolejności chronologicznej. Wymagany jest co najmniej dwa waypoints. Jedno wywołanie interfejsu API może zawierać do 60 waypoints. Punkt nawigacyjny wskazuje lokalizację, Eat i opcjonalny nagłówek: szerokości geograficznej, długości geograficznej, Eat, nagłówka, gdzie

  • Latitude -Współrzędnej szerokości geograficznej w stopniach dziesiętnych.
  • Longitude Współrzędnej długości geograficznej w stopniach dziesiętnych.
  • ETA (estimated time of arrival) — Liczba minut od aktualnego czasu, przez który będzie trwać do punkt nawigacyjny. Dozwolony zakres to od 0,0 do 120,0 minut.
  • Heading — Wartość opcjonalna wskazująca, że nagłówek pojazdu przejdzie do punkt nawigacyjny. Wyrażony w stopniach w prawo względem prawdy (północ). Jest on wydawany w celu obliczenia odblasku Sun jako zagrożenia. Dozwolony zakres to od 0,0 do 360,0 stopni. Jeśli nie zostanie podany, nagłówek zostanie automatycznie utworzony na podstawie pozycji sąsiadujących waypoints.

Zalecane jest pozostawanie w obrębie, lub w pobliżu, odległości, która może być przenoszona w ciągu 120 minut lub wkrótce. W ten sposób można zapewnić dokładniejszą ocenę dla podróży i uniemożliwić izolowane zdarzenia, które nie są przechwytywane między waypoints. Informacje mogą i powinny być aktualizowane wraz z trasą (zwłaszcza w przypadku podróży dłuższych niż 2 godziny) do ciągłego ściągania nowych waypointsów, ale również w celu zapewnienia, że informacje prognozy dotyczące zawartości, takie jak typ wytrącania i intensywność, są dokładne w miarę rozwoju i rozpraszania w czasie.

language
query
  • string

Język, w którym mają być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Jeśli dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny. Wartość domyślna to en-us.

Aby uzyskać szczegółowe informacje, zapoznaj się z obsługiwanymi językami .

subscription-key
query
  • string

Jeden z kluczy Azure Maps dostarczonych z konta usługi Azure map. Zapoznaj się z tym artykułem , aby uzyskać szczegółowe informacje na temat zarządzania uwierzytelnianiem.

Nagłówek żądania

Name Required Type Description
x-ms-client-id
  • string

Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń usługi Azure AD. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta Azure Maps płaszczyzny zarządzania. Aby skorzystać z zabezpieczeń usługi Azure AD w Azure Maps zobacz następujące artykuły , aby uzyskać wskazówki.

Odpowiedzi

Name Type Description
200 OK

OK

400 Bad Request

Złe żądanie: co najmniej jeden parametr został niepoprawnie określony lub wykluczają się wzajemnie.

401 Unauthorized

Odmowa dostępu z powodu nieprawidłowego klucza subskrypcji lub nieprawidłowy token Azure Active Directory okaziciela. Upewnij się, że podano prawidłowy klucz dla aktywnej subskrypcji platformy Azure i zamapowanego zasobu. W przeciwnym razie Sprawdź nagłówek www-Authenticate dla kodu błędu i opis podanego tokenu okaziciela usługi AAD.

Headers

  • WWW-Authenticate: string
403 Forbidden

Problemy z uprawnieniami, pojemnością lub uwierzytelnianiem.

404 Not Found

Nie znaleziono: nie można znaleźć żądanego zasobu, ale może on być ponownie dostępny w przyszłości.

500 Internal Server Error

Wystąpił błąd podczas przetwarzania żądania. Spróbuj ponownie później.

Zabezpieczenia

azure_auth

Są to Azure Active Directory przepływy OAuth2 . W przypadku sparowania z kontrolą dostępu opartą na rolach na platformie Azure można kontrolować dostęp do Azure Maps interfejsów API REST. Kontrola dostępu oparta na rolach na platformie Azure służy do wyznaczania dostępu do co najmniej jednego Azure Maps konta zasobu lub podzasobów. Do wszystkich użytkowników, grup lub jednostek usługi można udzielić dostępu za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.

Aby zaimplementować scenariusze, zalecamy wyświetlanie pojęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń zapewnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które umożliwiają kontrolę dostępu do określonych interfejsów API i zakresów.

Uwaga

  • Ta definicja zabezpieczeń wymaga użycia x-ms-client-id nagłówka, aby wskazać, który Azure Maps zasób, do którego aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.
  • Authorization URLJest to specyficzne dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje usługi Azure Active Directory.
  • Kontrola dostępu oparta na rolach na platformie Azure jest konfigurowana z poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
  • Użycie Azure Maps Web SDK umożliwia konfigurowanie aplikacji na podstawie konfiguracji w wielu przypadkach użycia.
  • Obecnie obsługiwane są tokeny Azure Active Directory v 1.0 .

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

subscription-key

Jest to klucz współużytkowany, który jest inicjowany podczas tworzenia zasobu Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia platformy Azure lub interfejsów API REST. Przy użyciu tego klucza każda aplikacja ma autoryzację dostępu do wszystkich interfejsów API REST. Inaczej mówiąc, te dane mogą być obecnie traktowane jako klucze główne do konta, dla którego są wystawiane. W przypadku aplikacji publicznie narażonych zaleca się używanie serwera do dostępu do serwera Azure Maps interfejsów API REST, w których ten klucz może być bezpiecznie przechowywany.

Type: apiKey
In: query

Przykłady

WeatherAlongRoute

Sample Request

GET https://atlas.microsoft.com/weather/route/json?api-version=1.0&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": []
    }
  ]
}
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Definicje

HazardDetail
Hazards
JsonFormat

Żądany format odpowiedzi. jsonObsługiwany jest tylko format.

Notification
ODataError

Ten obiekt jest zwracany, gdy w interfejsie API Maps wystąpi błąd.

ODataErrorResponse

Ten obiekt odpowiedzi jest zwracany, gdy w interfejsie API Maps wystąpi błąd.

SunGlare

Ocena wskazująca, jak żaluzja jest dla sterownika.

Waypoint
WeatherAlongRoutePrecipitation
WeatherAlongRouteResponse

Ten obiekt jest zwracany z pomyślnej pogody wzdłuż trasy.

WeatherAlongRouteSummary
WeatherUnit
Wind

Są zwracane szczegóły wiatru, w tym szybkość i kierunek.

WindDirection

Kierunek wiatru

WindSpeed

Prędkość wiatru w określonej jednostce.

HazardDetail

Name Type Description
hazardCode
  • string

Unikatowy identyfikator (niedrukowalny) dla każdego typu zagrożenia: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, grad, LargeHail, SunGlareHigh, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning,

hazardIndex
  • integer

Indeks ważności/zagrożenia.

  • 0 -Brak zagrożenia.
  • 1 — Należy pamiętać o tym.
  • 2 -Płatność powinna zostać przygotowana.
  • 3 -Zrób akcję.
  • 4 -Zagrożenia życiowe, awaryjne.
shortPhrase
  • string

Skrócona krótka fraza opisująca przewidywane warunki i intensywność wytrącania/typ.

Hazards

Name Type Description
hazardDetails

Szczegóły dotyczące zagrożeń pogodowych wpływających na podróż.

maxHazardIndex
  • integer

Indeks ważności/zagrożenia.

  • 0 -Brak zagrożenia.
  • 1 — Należy pamiętać o tym.
  • 2 -Płatność powinna zostać przygotowana.
  • 3 -Zrób akcję.
  • 4 -Zagrożenia życiowe, awaryjne.

JsonFormat

Żądany format odpowiedzi. jsonObsługiwany jest tylko format.

Name Type Description
json
  • string

JavaScript Object Notation format wymiany danych

Notification

Name Type Description
hazardCode
  • string

Unikatowy identyfikator (niedrukowalny) dla każdego typu zagrożenia: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, grad, LargeHail, SunGlareHigh, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning,

hazardIndex
  • integer

Indeks ważności/zagrożenia.

  • 0 -Brak zagrożenia.
  • 1 — Należy pamiętać o tym.
  • 2 -Płatność powinna zostać przygotowana.
  • 3 -Zrób akcję.
  • 4 -Zagrożenia życiowe, awaryjne.
shortPhrase
  • string

Skrócona krótka fraza opisująca przewidywane warunki i intensywność wytrącania/typ.

type
  • string

Typ powiadomień generowanych w celu ostrzegania kierowców o wystąpieniu zagrożenia lub zwiększania stopnia zagrożenia.

ODataError

Ten obiekt jest zwracany, gdy w interfejsie API Maps wystąpi błąd.

Name Type Description
code
  • string

Kod ODataError.

details

Ten obiekt jest zwracany, gdy w interfejsie API Maps wystąpi błąd.

message
  • string

Jeśli jest dostępny, czytelny dla człowieka opis błędu.

target
  • string

Jeśli jest dostępny, obiekt docelowy powoduje błąd.

ODataErrorResponse

Ten obiekt odpowiedzi jest zwracany, gdy w interfejsie API Maps wystąpi błąd.

Name Type Description
error

Ten obiekt jest zwracany, gdy w interfejsie API Maps wystąpi błąd.

SunGlare

Ocena wskazująca, jak żaluzja jest dla sterownika.

Name Type Description
calculatedVehicleHeading
  • integer

Jeśli nie podano wartości nagłówka pojazdu dla elementu punkt nawigacyjny, usługa obliczy nagłówek na podstawie lokalizacji sąsiedniego waypoints, jeśli zostanie podany.

glareIndex
  • integer

Indeks od 0 do 100 wskazujący intensywność odblasku dla sterownika. Wartość 50 i powyżej może być traktowana jako zagrożenie dla niektórych sterowników, a wartość 100 oznacza, że sterownik jest napędzany bezpośrednio w warunkach Sun i atmosferycznych, co pozwala na całkowite intensywność usuwania sterownika.

Waypoint

Name Type Description
cloudCover
  • integer

Procent reprezentujący odkryte chmurę.

hazards
iconCode
  • integer

Wartość liczbowa reprezentująca obraz, który wyświetla iconPhrase . Aby uzyskać szczegółowe informacje, zapoznaj się z pojęciami dotyczącymi usługi Pogoda .

isDayTime
  • boolean

Wskazuje godzinę dnia. Wartość true wskazuje "dzień", ", FAŁSZ wskazuje" noc.

lightningCount
  • integer

Oszacowanie intensywności Thunderstorm na otwartej skali. Wartość 0 oznacza, że nie ma Thunderstorm; wartości 1 i wyższe oznaczają Thunderstorm zwiększające intensywność.

notifications
precipitation
shortPhrase
  • string

Skrócona krótka fraza opisująca przewidywane warunki i intensywność wytrącania/typ.

sunGlare

Ocena wskazująca, jak żaluzja jest dla sterownika.

temperature
wind

Są zwracane szczegóły wiatru, w tym szybkość i kierunek.

windGust

Są zwracane szczegóły wiatru, w tym szybkość i kierunek.

WeatherAlongRoutePrecipitation

Name Type Description
dbz
  • number

Prognozowana intensywność wytrącania w dBZ (decybele względem z) od 0,0 do 100,0.

type
  • string

Typ wytrącania. Jeśli wytrącenie powinno wystąpić, typ, który będzie: "deszcz", "", ",", "lód", "lodem" lub "MIX".

WeatherAlongRouteResponse

Ten obiekt jest zwracany z pomyślnej pogody wzdłuż trasy.

Name Type Description
summary
waypoints

Dane dla każdego punkt nawigacyjny zwrócone w kolejności określonej w żądaniu.

WeatherAlongRouteSummary

Name Type Description
hazards
iconCode
  • integer

Wartość liczbowa reprezentująca obraz, który wyświetla iconPhrase . Aby uzyskać szczegółowe informacje, zapoznaj się z pojęciami dotyczącymi usługi Pogoda .

WeatherUnit

Name Type Description
unit
  • string

Typ jednostki dla zwracanej wartości.

unitType
  • integer

Wartość identyfikatora liczbowego skojarzona z typem wyświetlanej jednostki. Może służyć do translacji jednostek. Aby uzyskać szczegółowe informacje, zapoznaj się z pojęciami dotyczącymi usługi Pogoda .

value
  • number

Zaokrąglona wartość.

Wind

Są zwracane szczegóły wiatru, w tym szybkość i kierunek.

Name Type Description
direction

Kierunek wiatru

speed

Prędkość wiatru w określonej jednostce.

WindDirection

Kierunek wiatru

Name Type Description
degrees
  • integer

Kierunek wiatru w stopniach Azimuth, zaczynając od prawdziwej północy i kontynuując zgodnie z ruchem wskazówek zegara. Północ ma 0 stopni, wschód to 90 stopni, południe ma 180 stopni, zachodnie to 270 stopni. Możliwe wartości 0-359.

localizedDescription
  • string

Skrót kierunku w określonym języku.

WindSpeed

Prędkość wiatru w określonej jednostce.

Name Type Description
unit
  • string

Typ jednostki dla wartości szybkości.

unitType
  • integer

Wartość identyfikatora liczbowego skojarzona z typem wyświetlanej jednostki. Może służyć do translacji jednostek. Aby uzyskać szczegółowe informacje, zapoznaj się z pojęciami dotyczącymi usługi Pogoda .

value
  • number

Zaokrąglona wartość szybkości.