Weather - Get Daily Indices

Referencia

Szolgáltatás:: Maps

API-verzió:: 1.1

Akkor érdemes használni, ha tudni szeretné, hogy az időjárási viszonyok optimálisak-e egy adott tevékenységhez, például a szabadtéri sporttevékenységekhez, az építőiparhoz vagy a gazdálkodáshoz (az eredmények tartalmazzák a talaj nedvességével kapcsolatos információkat).

Az Get Daily Indices API egy HTTP-kérés GET , amely indexértékeket ad vissza, amelyek útmutatást nyújtanak a jövőbeli tevékenységek tervezéséhez. Egy egészségügyi mobilalkalmazás például értesítheti a felhasználókat, hogy ma jó az időjárás futáshoz vagy más szabadtéri tevékenységekhez, például golfozni vagy sárkányrepüléshez. A kiskereskedelmi üzletek optimalizálhatják digitális marketingkampányaikat az előrejelzett indexértékek alapján. A szolgáltatás az aktuális és a következő 5, 10 és 15 napra vonatkozó napi indexértékeket adja vissza az aktuális naptól kezdve.

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
format	path	True	JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
api-version	query	True	string	Az Azure Maps API verziószáma.
query	query	True	number[]	A megfelelő lekérdezés, amelyet vesszővel tagolt sztringként határoz meg, amelyet szélesség és hosszúság követ, például:"47.641268,-122.125679".
duration	query		integer	Megadja, hogy a napi indexek hány napig lesznek visszaadva. Alapértelmezés szerint az aktuális napra vonatkozó indexadatok lesznek visszaadva. A jövőbeli indexadatok lekérésekor az aktuális nap 1. napként jelenik meg a válaszban. A rendelkezésre álló értékek a következők: `1` – Az aktuális napra vonatkozó napi indexadatok visszaadása. Alapértelmezett érték. `5` – Az aktuális naptól kezdődően 5 napi indexadatot ad vissza. `10` – 10 nap napi indexadatokat ad vissza az aktuális naptól kezdve. `15` – Az aktuális naptól kezdődően 15 napi indexadatot ad vissza.
indexGroupId	query		integer	Numerikus indexcsoport-azonosító, amely a visszaadott eredmények indexek megfelelő részhalmazára (indexcsoportra) korlátozható. Nem párosítható a következővel `indexId`: . A részletekért és a támogatott indexcsoportok megtekintéséhez tekintse meg az Azure Maps időjárási szolgáltatásaival foglalkozó cikket.
indexId	query		integer	Numerikus indexazonosító, amely a visszaadott eredmények megfelelő indextípusra való korlátozására használható. Nem párosítható a következővel `indexGroupId`: . A részletekért és a támogatott indexek megtekintéséhez tekintse meg az Azure Maps időjárási szolgáltatásaival foglalkozó cikket.
language	query		string	Az a nyelv, amelyben a keresési eredményeket vissza kell adni. A támogatott IETF nyelvcímkék egyikének kell lennie, a kis- és nagybetűk nem különböztethetők meg. Ha a megadott nyelvű adatok nem érhetők el egy adott mezőhöz, a rendszer az alapértelmezett nyelvet használja. Részletekért tekintse meg a támogatott nyelveket ismertető cikket.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Ez az Azure Maps-fiók egyedi azonosítóját jelöli, amely az Azure Maps felügyeleti sík fiók API-jából kérhető le. A Microsoft Entra ID security Azure Mapsben való használatához az alábbi cikkek nyújtanak útmutatást.

Válaszok

Name	Típus	Description
200 OK	DailyIndicesResult	OK
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek a Microsoft Entra OAuth 2.0-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható az Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps-erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több Azure Maps REST API-ra vonatkozó engedélyből álló egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.

Jegyzetek

Ehhez a biztonsági definícióhoz a x-ms-client-id fejléc használatával kell jelezni, hogy az alkalmazás melyik Azure Maps-erőforráshoz kér hozzáférést. Ez a Maps management API-ból szerezhető be.

A Authorization URL az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID-konfigurációkkal rendelkeznek. * Az Azure-beli szerepköralapú hozzáférés-vezérlés az Azure felügyeleti síkjáról van konfigurálva az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy REST API-kon keresztül. * Az Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.

További információ a Microsoft identitásplatformról: A Microsoft identitásplatformjának áttekintése.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

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

subscription-key

Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps-fiókot hoz létre az Azure Portalon, vagy PowerShell, CLI, Azure SDK-k vagy REST API használatával.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítését használja az Azure Maps REST API-k eléréséhez, hogy a kulcs biztonságosan tárolható legyen.

Típus: apiKey
In: query

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat az Azure Maps-erőforrás Sas listázása műveletéből jön létre az Azure felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy REST API-kon keresztül.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.

Típus: apiKey
In: header

Példák

Successfully retrieve daily indices values from current day

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 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."
    }
  ]
}

Definíciók

Name	Description
DailyIndex	Napi index adatai.
DailyIndicesResult	Ezt az objektumot egy sikeres Napi indexek lekérése hívás adja vissza.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.

DailyIndex

Napi index adatai.

Name	Típus	Description
ascending	boolean	A és `categoryValue`az irányát `value` ismerteti. Ha például a értékre `true`van állítva, a legszegényebb indexérték 0, a legjobb indexérték pedig 10. Ha a értékre `true`van állítva, a legszegényebb indexérték 10, a legjobb indexérték pedig 0.
category	string	Szöveges leírás annak a szintnek `categoryValue` , amely alá az indexérték tartozik, például "Nagyon jó".
categoryValue	integer	Az indexérték alá eső szint, amelyet egy egész szám jelöl. Ez az érték 1 és 5 között lehet, és a `ascending` jelzővel együtt kell használni, mert az indexek között eltérhet. A szúnyogtevékenységre például a következő értékek vonatkoznak: Low=1, Moderate=2, High=3, Very High=4 és Extreme=5.
dateTime	string	Az ISO 8601 formátumban megjelenített jelenlegi megfigyelés dátuma és időpontja, például 2019-10-27T19:39:57-08:00.
description	string	Szöveges magyarázat, amely megjeleníthető az indexérték és a kategória összegzéséhez. Ha például a Flight Delays indexértéke nagyon jó, a leírás a következő lesz: "A feltételek kiválóak a repüléshez!".
indexId	integer	Az adott index azonosítására használt numerikus azonosító. A részletekért és a támogatott indexazonosítók megtekintéséhez tekintse meg az Azure Maps időjárási szolgáltatásaival foglalkozó cikket. Az indexazonosító például támogatja a felhasználói felület vizualizációs forgatókönyveit.
indexName	string	Az index neve, például "Építőipar", "Kültéri tevékenység", "Járatkésések".
value	number	Indexérték. A tartomány 0,0 és 10,0 között lehet. A részletekért és a támogatott tartományok megtekintéséhez tekintse meg az Azure Maps Időjárási szolgáltatásai című témakört.

DailyIndicesResult

Ezt az objektumot egy sikeres Napi indexek lekérése hívás adja vissza.

Name	Típus	Description
results	DailyIndex[]	A lekérdezett hely összes napi indexének listája.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

JsonFormat

A válasz kívánt formátuma. Csak json a formátum támogatott.

Name	Típus	Description
json	string	A JavaScript object Notation Data Interchange formátuma

Megosztás a következőn keresztül: