Weather - Get Daily Indices

Referenz

Dienst:: Maps

API-Version:: 1.1

Verwenden Sie, wenn Sie wissen möchten, ob die Wetterbedingungen für eine bestimmte Aktivität wie Sportaktivitäten im Freien, Bau oder Landwirtschaft optimal sind (die Ergebnisse enthalten Informationen zur Bodenfeuchtigkeit).

Die Get Daily Indices API ist eine HTTP-Anforderung GET , die Indexwerte zurückgibt, die Bei der Planung zukünftiger Aktivitäten helfen. Beispielsweise kann eine mobile Health-Anwendung Benutzer darüber informieren, dass heute gutes Wetter zum Laufen oder für andere Aktivitäten im Freien wie Golfspielen oder Drachenfliegen ist. Einzelhandelsgeschäfte können ihre digitalen Marketingkampagnen basierend auf vorhergesagten Indexwerten optimieren. Der Dienst gibt in täglichen Indizes Werte für den aktuellen und die nächsten 5, 10 und 15 Tage ab dem aktuellen Tag zurück.

GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query={query}

Mit optionalen Parametern:

GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query={query}&language={language}&duration={duration}&indexId={indexId}&indexGroupId={indexGroupId}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	JsonFormat	Das gewünschte Format der Antwort. Nur das `json`-Format wird unterstützt.
api-version	query	True	string	Versionsnummer der Azure Maps API.
query	query	True	number[]	Die entsprechende Abfrage, die als durch Trennzeichen getrennte Zeichenfolge angegeben ist, die nach Breitengrad gefolgt von Längengrad besteht, z. B. "47.641268,-122.125679".
duration	query		integer	Gibt an, wie viele Tage die täglichen Indizes zurückgegeben werden. Standardmäßig werden die Indizesdaten für den aktuellen Tag zurückgegeben. Beim Anfordern zukünftiger Indizesdaten wird der aktuelle Tag als Tag 1 in die Antwort eingeschlossen. Verfügbare Werte sind: `1` – Gibt tägliche Indexdaten für den aktuellen Tag zurück. Standardwert. `5` - Gibt 5 Tage täglicher Indexdaten ab dem aktuellen Tag zurück. `10` – Gibt 10 Tage täglicher Indexdaten ab dem aktuellen Tag zurück. `15` – Gibt 15 Tage täglicher Indexdaten ab dem aktuellen Tag zurück.
indexGroupId	query		integer	Numerische Indexgruppenbezeichner, der verwendet werden kann, um zurückgegebene Ergebnisse auf die entsprechende Teilmenge von Indizes (Indexgruppe) einzuschränken. Kann nicht mit `indexId`gekoppelt werden. Weitere Informationen und die unterstützten Indexgruppen finden Sie unter Wetterdienste in Azure Maps .
indexId	query		integer	Numerischer Indexbezeichner, der verwendet werden kann, um zurückgegebene Ergebnisse auf den entsprechenden Indextyp einzuschränken. Kann nicht mit `indexGroupId`gekoppelt werden. Weitere Informationen und die unterstützten Indizes finden Sie unter Wetterdienste in Azure Maps .
language	query		string	Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eines der unterstützten IETF-Sprachtags sein, wobei die Groß-/Kleinschreibung nicht beachtet wird. Wenn Daten in der angegebenen Sprache für ein bestimmtes Feld nicht verfügbar sind, wird die Standardsprache verwendet. Weitere Informationen finden Sie unter Unterstützte Sprachen .

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie in den folgenden Artikeln .

Antworten

Name	Typ	Beschreibung
200 OK	DailyIndicesResult	OK
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows . In Kombination mit der rollenbasierten Zugriffssteuerung von Azure kann sie verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

Hinweise

Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

Ist Authorization URL spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen. * Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

Weitere Informationen zu Microsoft Identity Platform finden Sie unter Übersicht über Microsoft Identity Platform.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API bereitgestellt wird.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: Dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Dies ist ein Shared Access Signature-Token, das aus dem SAS-Listenvorgang für die Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Successfully retrieve daily indices values from current day

Beispielanforderung

HTTP

GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query=43.84745,-79.37849&indexGroupId=11

Beispiel für eine Antwort

Statuscode:: 200

{
  "results": [
    {
      "indexName": "Running Forecast",
      "indexId": 1,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.2,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is an excellent day for outdoor running!"
    },
    {
      "indexName": "Jogging Forecast",
      "indexId": 2,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.4,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "Conditions are excellent for jogging outdoors!"
    },
    {
      "indexName": "Hiking Forecast",
      "indexId": 3,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.8,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "Conditions are excellent for hiking!"
    },
    {
      "indexName": "Bicycling Forecast",
      "indexId": 4,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.9,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "Conditions are excellent for bicycling outdoors!"
    },
    {
      "indexName": "Golf Weather Forecast",
      "indexId": 5,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 10,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is a great day for golf."
    },
    {
      "indexName": "Tennis Forecast",
      "indexId": 6,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.2,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is an excellent day for playing tennis!"
    },
    {
      "indexName": "Skateboarding Forecast",
      "indexId": 7,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.9,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is an excellent day for skateboarding!"
    },
    {
      "indexName": "Outdoor Concert Forecast",
      "indexId": 8,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.7,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "Conditions are excellent for attending an outdoor concert!"
    },
    {
      "indexName": "Kite Flying Forecast",
      "indexId": 9,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 8.5,
      "category": "Very Good",
      "categoryValue": 4,
      "ascending": true,
      "description": "Conditions are very good today for kite-flying."
    },
    {
      "indexName": "Beach & Pool Forecast",
      "indexId": 10,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 8.6,
      "category": "Very Good",
      "categoryValue": 4,
      "ascending": true,
      "description": "Conditons will be very good for a visit to the beach or pool."
    },
    {
      "indexName": "Sailing Forecast",
      "indexId": 11,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 8.3,
      "category": "Very Good",
      "categoryValue": 4,
      "ascending": true,
      "description": "Conditions will be very good for sailing."
    },
    {
      "indexName": "Stargazing Forecast",
      "indexId": 12,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.5,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is a great night to be stargazing!"
    },
    {
      "indexName": "Fishing Forecast",
      "indexId": 13,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 3.5,
      "category": "Fair",
      "categoryValue": 2,
      "ascending": true,
      "description": "Expect only fair conditions for fishing."
    },
    {
      "indexName": "Ski Weather Forecast",
      "indexId": 15,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 0,
      "category": "Poor",
      "categoryValue": 1,
      "ascending": true,
      "description": "Expect poor conditions for skiing."
    },
    {
      "indexName": "Mosquito Activity Forecast",
      "indexId": 17,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 7,
      "category": "Very High",
      "categoryValue": 4,
      "ascending": true,
      "description": "The weather is favorable for a very high level of mosquito activity. Plan activities and insect repellents accordingly."
    },
    {
      "indexName": "Hunting Forecast",
      "indexId": 20,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 4.5,
      "category": "Fair",
      "categoryValue": 2,
      "ascending": true,
      "description": "Expect only fair conditions for hunting."
    },
    {
      "indexName": "Outdoor Barbecue",
      "indexId": 24,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.8,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is a great day for an outdoor barbecue!"
    },
    {
      "indexName": "Lawn Mowing Forecast",
      "indexId": 28,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.6,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is a great day for lawn mowing!"
    },
    {
      "indexName": "Outdoor Activity Forecast",
      "indexId": 29,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 8.7,
      "category": "Very Good",
      "categoryValue": 4,
      "ascending": true,
      "description": "Conditions will be very good for outdoor activities."
    }
  ]
}

Definitionen

Name	Beschreibung
DailyIndex	Informationen zu einem täglichen Index.
DailyIndicesResult	Dieses Objekt wird von einem erfolgreichen Aufruf zum Abrufen täglicher Indizes zurückgegeben.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
JsonFormat	Das gewünschte Format der Antwort. Nur das `json`-Format wird unterstützt.

DailyIndex

Informationen zu einem täglichen Index.

Name	Typ	Beschreibung
ascending	boolean	Beschreibt die Richtung von `value` und `categoryValue`. Wenn sie beispielsweise auf `true`festgelegt ist, ist der schlechteste Indexwert 0 und der beste Indexwert ist 10. Bei Festlegung auf `true`ist der schlechteste Indexwert 10 und der beste Indexwert 0.
category	string	Textbeschreibung für `categoryValue` die Ebene, unter der der Indexwert fällt, z. B. "Sehr gut".
categoryValue	integer	Ebene, unter der der Indexwert fällt, dargestellt durch eine ganze Zahl. Dieser Wert kann 1 bis 5 sein und sollte in Kombination mit dem `ascending` Flag verwendet werden, da er sich zwischen den Indizes unterscheiden kann. Beispielsweise gelten die folgenden Werte für Mosquito Activity: Low=1, Moderate=2, High=3, Very High=4 und Extreme=5.
dateTime	string	Datum und Uhrzeit der aktuellen Beobachtung im ISO 8601-Format, z. B. 2019-10-27T19:39:57-08:00.
description	string	Eine Texterklärung, die zu Anzeigezwecken verwendet werden kann, um den Indexwert und die Kategorie zusammenzufassen. Wenn beispielsweise der Indexwert für Flugverspätungen sehr gut ist, lautet die Beschreibung "Bedingungen sind hervorragend für das Fliegen!".
indexId	integer	Numerische ID, die verwendet wird, um den spezifischen Index zu identifizieren. Weitere Informationen und die unterstützten Index-IDs finden Sie unter Wetterdienste in Azure Maps . Beispielsweise kann die Index-ID Benutzeroberflächenvisualisierungsszenarien unterstützen.
indexName	string	Name des Indexes, z. B. "Construction", "Outdoor Activity", "Flight Delays".
value	number	Sollwert. Bereiche von 0,0 bis 10,0. Ausführliche Informationen und die unterstützten Bereiche finden Sie unter Wetterdienste in Azure Maps .

DailyIndicesResult

Dieses Objekt wird von einem erfolgreichen Aufruf zum Abrufen täglicher Indizes zurückgegeben.

Name	Typ	Beschreibung
results	DailyIndex[]	Eine Liste aller täglichen Indizes für den abgefragten Standort.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

JsonFormat

Das gewünschte Format der Antwort. Nur das json-Format wird unterstützt.

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation

Freigeben über