Weather - Get Daily Indices

Referentie

Service:: Maps

API-versie:: 1.1

Gebruik dit als u wilt weten of de weersomstandigheden optimaal zijn voor een specifieke activiteit, zoals buitensportactiviteiten, bouw of landbouw (resultaten omvatten informatie over bodemvochtigheid).

De Get Daily Indices API is een HTTP-aanvraag GET die indexwaarden retourneert die hulp bieden bij het plannen van toekomstige activiteiten. Een mobiele gezondheidstoepassing kan gebruikers bijvoorbeeld waarschuwen dat het vandaag goed weer is voor hardlopen of voor andere buitenactiviteiten, zoals golfen of vliegen met een vlieger. Winkels kunnen hun digitale marketingcampagnes optimaliseren op basis van voorspelde indexwaarden. De service retourneert in dagelijkse indexwaarden voor huidige en volgende 5, 10 en 15 dagen vanaf de huidige dag.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
format	path	True	JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
api-version	query	True	string	Versienummer van Azure Maps-API.
query	query	True	number[]	De toepasselijke query die is opgegeven als een door komma's gescheiden tekenreeks die is samengesteld door breedtegraad gevolgd door lengtegraad, bijvoorbeeld '47,641268,-122,125679'.
duration	query		integer	Hiermee geeft u op hoeveel dagen de dagindexen worden geretourneerd. Standaard worden de indexgegevens voor de huidige dag geretourneerd. Bij het aanvragen van toekomstige indexgegevens wordt de huidige dag opgenomen in het antwoord als dag 1. Beschikbare waarden zijn `1` - Dagelijkse indexgegevens voor de huidige dag retourneren. Standaardwaarde. `5` - Retourneer 5 dagen aan dagelijkse indexgegevens vanaf de huidige dag. `10` - Retourneer 10 dagen aan dagelijkse indexgegevens vanaf de huidige dag. `15` - Retourneer 15 dagen aan dagelijkse indexgegevens vanaf de huidige dag.
indexGroupId	query		integer	Numerieke indexgroep-id die kan worden gebruikt om geretourneerde resultaten te beperken tot de bijbehorende subset van indexen (indexgroep). Kan niet worden gekoppeld met `indexId`. Raadpleeg Weerservices in Azure Maps voor meer informatie en om de ondersteunde indexgroepen weer te geven.
indexId	query		integer	Numerieke index-id die kan worden gebruikt om geretourneerde resultaten te beperken tot het bijbehorende indextype. Kan niet worden gekoppeld met `indexGroupId`. Raadpleeg Weerservices in Azure Maps voor meer informatie en om de ondersteunde indexen weer te geven.
language	query		string	Taal waarin zoekresultaten moeten worden geretourneerd. Moet een van de ondersteunde IETF-taaltags zijn, niet hoofdlettergevoelig. Wanneer gegevens in de opgegeven taal niet beschikbaar zijn voor een specifiek veld, wordt de standaardtaal gebruikt. Raadpleeg Ondersteunde talen voor meer informatie.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps-beheervlak Account-API. Als u Microsoft Entra ID-beveiliging in Azure Maps wilt gebruiken, raadpleegt u de volgende artikelen voor hulp.

Antwoorden

Name	Type	Description
200 OK	DailyIndicesResult	OK
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen . Wanneer het wordt gekoppeld met op rollen gebaseerd toegangsbeheer van Azure , kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps-resourceaccounts of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API .

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt het mogelijk om een toepassing op basis van configuraties in te stellen voor meerdere gebruiksvoorbeelden.

Zie Overzicht van Microsoft Identity Platform voor meer informatie over Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account maakt in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een Shared Access Signature-token dat is gemaakt op basis van de SAS-bewerking List op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Successfully retrieve daily indices values from current day

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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."
    }
  ]
}

Definities

Name	Description
DailyIndex	Informatie over een dagelijkse index.
DailyIndicesResult	Dit object wordt geretourneerd na een geslaagde aanroep Dagelijkse indexen ophalen.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.

DailyIndex

Informatie over een dagelijkse index.

Name	Type	Description
ascending	boolean	Beschrijft de richting van de `value` en `categoryValue`. Als deze optie bijvoorbeeld is ingesteld op `true`, is de laagste indexwaarde 0 en is de beste indexwaarde 10. Als dit is ingesteld op `true`, is de laagste indexwaarde 10 en is de beste indexwaarde 0.
category	string	Tekstuele beschrijving voor `categoryValue` het niveau waar de indexwaarde onder valt, bijvoorbeeld 'Zeer goed'.
categoryValue	integer	Niveau opgeven waar de indexwaarde onder valt, vertegenwoordigd door een geheel getal. Deze waarde kan 1 tot en met 5 zijn en moet worden gebruikt in combinatie met de `ascending` vlag, omdat deze per index kan verschillen. De volgende waarden zijn bijvoorbeeld van toepassing op mugactiviteit: Laag=1, Gemiddeld=2, Hoog=3, Zeer hoog=4 en Extreem=5.
dateTime	string	Datum en tijd van de huidige waarneming weergegeven in ISO 8601-notatie, bijvoorbeeld 2019-10-27T19:39:57-08:00.
description	string	Een tekstuele uitleg die kan worden gebruikt voor weergavedoeleinden om de indexwaarde en categorie samen te vatten. Als de indexwaarde voor Vluchtvertragingen bijvoorbeeld zeer goed is, wordt de beschrijving 'Voorwaarden zijn uitstekend voor vliegen!'.
indexId	integer	De numerieke id die wordt gebruikt om de specifieke index te identificeren. Raadpleeg Weerservices in Azure Maps voor meer informatie en om de ondersteunde index-id's te bekijken. De index-id kan bijvoorbeeld visualisatiescenario's voor gebruikersinterfaces ondersteunen.
indexName	string	Naam van de index, bijvoorbeeld 'Constructie', 'Buitenactiviteit', 'Vluchtvertragingen'.
value	number	Indexwaarde. Varieert van 0,0 tot 10,0. Raadpleeg Weerservices in Azure Maps voor meer informatie en om de ondersteunde bereiken te bekijken.

DailyIndicesResult

Dit object wordt geretourneerd na een geslaagde aanroep Dagelijkse indexen ophalen.

Name	Type	Description
results	DailyIndex[]	Een lijst met alle dagelijkse indexen voor de opgevraagde locatie.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

JsonFormat

Gewenste indeling van het antwoord. Alleen json de indeling wordt ondersteund.

Name	Type	Description
json	string	De JavaScript Object Notation Data Interchange-indeling

Delen via