Weather - Get Daily Indices

Dienst:: Maps

API-Version:: 1.1

Verwenden Sie diese Option, wenn Sie wissen möchten, ob die Wetterbedingungen für eine bestimmte Aktivität optimal sind, z. B. für sportliche Aktivitäten im Freien, auf dem Bau oder in der Landwirtschaft (die Ergebnisse enthalten Informationen zur Bodenfeuchtigkeit).

Bei der Get Daily Indices API handelt es sich um eine HTTP-Anforderung GET , die Indexwerte zurückgibt, die bei der Planung zukünftiger Aktivitäten hilfreich sind. Beispielsweise kann eine mobile Gesundheitsanwendung Benutzer darüber informieren, dass heute gutes Wetter zum Laufen oder für andere Outdoor-Aktivitäten wie Golfspielen oder Drachensteigen ist. Einzelhandelsgeschäfte können ihre digitalen Marketingkampagnen auf der Grundlage von prognostizierten Indexwerten optimieren. Der Dienst gibt tägliche Indizes 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	Gewünschtes Format der Antwort. Nur `json` Format wird unterstützt.
api-version	query	True	string	Versionsnummer der Azure Maps-API.
query	query	True	number[]	Die entsprechende Abfrage, die als kommagetrennte Zeichenfolge angegeben wird, die durch Breitengrad und Längengrad besteht, z. B. "47.641268,-122.125679". Wetterinformationen sind in der Regel für Orte an Land, von Land umgebene Gewässer und Bereiche des Ozeans verfügbar, die sich innerhalb von etwa 50 Seemeilen um eine Küste befinden.
duration	query		integer	Gibt an, für wie viele Tage die täglichen Indizes zurückgegeben werden. Standardmäßig werden die Indexdaten für den aktuellen Tag zurückgegeben. Bei der Abfrage von Daten zu Future-Indizes wird der aktuelle Tag als Tag 1 in die Antwort einbezogen. Verfügbare Werte sind `1` - Gibt tägliche Indexdaten für den aktuellen Tag zurück. Standardwert. `5` - Gibt 5 Tage mit täglichen Indexdaten zurück, beginnend mit dem aktuellen Tag. `10` - Gibt tägliche Indexdaten für 10 Tage zurück, beginnend mit dem aktuellen Tag. `15` - Gibt tägliche Indexdaten für 15 Tage zurück, beginnend mit dem aktuellen Tag.
indexGroupId	query		integer	Numerischer Indexgruppenbezeichner, der verwendet werden kann, um zurückgegebene Ergebnisse auf die entsprechende Teilmenge von Indizes (Indexgruppe) einzuschränken. Kann nicht mit gekoppelt werden `indexId`. Weitere Informationen und Informationen zu den unterstützten Indexgruppen finden Sie unter Wetterdienste in Azure Maps .
indexId	query		integer	Numerischer Indexbezeichner, der zum Einschränken zurückgegebener Ergebnisse auf den entsprechenden Indextyp verwendet werden kann. Kann nicht mit gekoppelt werden `indexGroupId`. Weitere Informationen und Informationen zu den unterstützten Indizes finden Sie unter Wetterdienste in Azure Maps .
language	query		string	Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eine der unterstützten IETF-Sprachtags sein, Groß-/Kleinschreibung wird nicht beachtet. 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ützten Sprachen.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt das Konto an, das für die Verwendung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Diese eindeutige ID für das Azure Maps-Konto kann über die Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Weitere Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie unter Verwalten der Authentifizierung in Azure Maps.

Antworten

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

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

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 Kartenverwaltung API erworben werden.

Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen. * Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, 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 zur Microsoft Identity Platform finden Sie unter Übersicht über die 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 freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.

Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz 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 Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und feinkörniger Kontrolle auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token autorisiert. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen das Steuern des Zugriffs auf eine sicherere Weise zu ermöglichen als der freigegebene Schlüssel.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch 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	Das DailyIndex-Objekt hilft den Nutzern, Outdoor-Aktivitäten basierend auf Wetterbedingungen zu planen, indem es den Namen der Aktivität angibt, wie zum Beispiel 'Skiwettervorhersage'; eine numerische Bewertung von 0,0 bis 10,0, die die Eignung anzeigt; eine Textbewertung, wie zum Beispiel "Schlecht"; und eine kurze Beschreibung der Bedingungen, wie zum Beispiel 'Erwarten Sie schlechte Bedingungen zum Skifahren.'
DailyIndicesResult	Dieses Objekt wird von einem erfolgreichen Get Daily Indices-Aufruf zurückgegeben.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
JsonFormat	Gewünschtes Format der Antwort. Nur `json` Format wird unterstützt.

DailyIndex

Objekt

Das DailyIndex-Objekt hilft den Nutzern, Outdoor-Aktivitäten basierend auf Wetterbedingungen zu planen, indem es den Namen der Aktivität angibt, wie zum Beispiel 'Skiwettervorhersage'; eine numerische Bewertung von 0,0 bis 10,0, die die Eignung anzeigt; eine Textbewertung, wie zum Beispiel "Schlecht"; und eine kurze Beschreibung der Bedingungen, wie zum Beispiel 'Erwarten Sie schlechte Bedingungen zum Skifahren.'

Name	Typ	Beschreibung
ascending	boolean	Gibt die Richtung der `value` und `categoryValue` Eigenschaften an. Wenn zutreffend, ist der schlechteste Indexwert 0 und der beste Indexwert 10. Wenn falsch, ist der schlechteste Indexwert 10 und der beste Indexwert 0.
category	string	Bietet eine qualitative Bewertung des Index und beschreibt die Immobilie `categoryValue` . Die Kategorien variieren zwischen den Indizes und können Werte wie Ausgezeichnet, Sehr Gut, Gut, Durchschnittlich und Schlecht umfassen.
categoryValue	integer (int32)	Bietet eine numerische Darstellung der Kategorie-Eigenschaft, die die qualitative Bewertung des Index angibt. Die Werte reichen von 1 bis 5 und sollten mit der aufsteigenden Flagge verwendet werden, da sie zwischen den Indizes unterschiedlich sein können. Zum Beispiel für Mückenaktivität: Niedrig=1, Mäßig=2, Hoch=3, Sehr hoch=4, Extrem=5.
dateTime	string (date-time)	Datum und Uhrzeit der Beobachtung im ISO-8601-Format (yyyy-mm-ddThh:mm:ss-hh:mm). Zum Beispiel 2025-04-29T07:00:00-07:00.
description	string	Bietet eine kurze, benutzerfreundliche Erklärung des Indexwerts, die den Nutzern hilft, seine Bedeutung im Zusammenhang mit bestimmten Wetterbedingungen oder Aktivitäten zu verstehen. Wenn zum Beispiel der Indexwert für Outdoor-Barbecue 'Ausgezeichnet' ist, lautet die Beschreibung: 'Dies ist ein großartiger Tag für ein Outdoor-Barbecue!'
indexId	integer (int32)	Ein numerischer Identifikator, der eindeutig einen bestimmten Indextyp darstellt und zwischen verschiedenen Indizes für verschiedene Outdoor-Aktivitäten unterscheidet. Zum Beispiel entspricht eine 'indexId' von 1 dem 'Running'-Index, und eine 'indexId' von 5 dem 'Golfing'-Index. Weitere Informationen finden Sie unter Index-IDs im Artikel Weather Service in Azure Maps zu den Konzepten.
indexName	string	Der Name des Indexes, der die Art der Aktivität oder Bedingung angibt, auf die er sich bezieht, wie zum Beispiel Laufen, Golf oder andere Outdoor-Aktivitäten. Weitere Informationen finden Sie unter Index-IDs im Artikel Weather Service in Azure Maps zu den Konzepten.
value	number (float)	Ein numerischer Indexwert von 0,0 bis 10,0, der die Eignung von Wetterbedingungen für eine bestimmte Aktivität oder Bedingung, wie Laufen oder Golfen, quantifiziert. Höhere Werte deuten typischerweise auf günstigere Bedingungen hin, abhängig vom Wert der Immobilie `ascending` . Zum Beispiel deutet ein Wert von 8 für den 'Running'-Index auf sehr gutes Wetter fürs Laufen hin, während ein Wert von 6 für den 'Golfing'-Index auf gute, aber etwas weniger ideale Bedingungen hinweist. Weitere Informationen finden Sie unter Daily Index Range Sets im Artikel Weather Service in Azure Maps Konzepten .

DailyIndicesResult

Objekt

Dieses Objekt wird von einem erfolgreichen Get Daily Indices-Aufruf zurückgegeben.

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

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

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

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

JsonFormat

Enumeration

Gewünschtes Format der Antwort. Nur json Format wird unterstützt.

Wert	Beschreibung
json	das JavaScript Object Notation Data Interchange Format

Freigeben über

Weather - Get Daily Indices

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

AADToken

Hinweise

Bereiche

subscription-key

SAS Token

Beispiele

Successfully retrieve daily indices values from current day

Beispielanforderung

Beispiel für eine Antwort

Definitionen

DailyIndex

DailyIndicesResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat