Weather - Get Daily Indices
Använd när du vill veta om väderförhållandena är optimala för en specifik aktivitet som sportaktiviteter utomhus, konstruktion eller jordbruk (resultaten inkluderar markfuktighetsinformation).
API:et Get Daily Indices
är en HTTP-begäran GET
som returnerar indexvärden som ger vägledning när du planerar framtida aktiviteter. Till exempel kan ett hälsomobilprogram meddela användare att dagens väder är bra för att köra eller för andra utomhusaktiviteter som att spela golf eller flyga en drake. Butiker kan optimera sina digitala marknadsföringskampanjer baserat på förutsagda indexvärden. Tjänsten returnerar i dagliga indexvärden för aktuella och kommande 5, 10 och 15 dagar från aktuell dag.
GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query={query}
GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query={query}&language={language}&duration={duration}&indexId={indexId}&indexGroupId={indexGroupId}
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
format
|
path | True |
Önskat format för svaret. Endast |
|
api-version
|
query | True |
string |
Versionsnummer för Azure Maps API. |
query
|
query | True |
number[] |
Den tillämpliga frågan som anges som en kommaavgränsad sträng som består av latitud följt av longitud, t.ex. "47.641268,-122.125679". |
duration
|
query |
integer |
Anger hur många dagar de dagliga indexen returneras. Som standard returneras indexdata för den aktuella dagen. När du begär framtida indexdata inkluderas den aktuella dagen i svaret som dag 1. Tillgängliga värden är
|
|
index
|
query |
integer |
Numerisk indexgruppsidentifierare som kan användas för att begränsa returnerade resultat till motsvarande delmängd av index (indexgrupp). Det går inte att para ihop med |
|
index
|
query |
integer |
Numerisk indexidentifierare som kan användas för att begränsa returnerade resultat till motsvarande indextyp. Det går inte att para ihop med |
|
language
|
query |
string |
Språk där sökresultat ska returneras. Bör vara en av IETF-språktaggar som stöds, skiftlägesokänsliga. När data på angivet språk inte är tillgängliga för ett visst fält används standardspråket. Mer information finns i Språk som stöds . |
Begärandehuvud
Name | Obligatorisk | Typ | Description |
---|---|---|---|
x-ms-client-id |
string |
Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från konto-API:et för Azure Maps hanteringsplan. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Det uppstod ett oväntat fel. |
Säkerhet
AADToken
Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.
För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.
Kommentarer
- Den här säkerhetsdefinitionen
x-ms-client-id
kräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API :et.
Authorization URL
är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer.
* Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.
* Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- Mer information om Microsofts identitetsplattform finns i Microsofts identitetsplattform översikt.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Det här är en delad nyckel som etableras när du Skapa ett Azure Maps konto i Azure Portal eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.
Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som huvudnyckel i det konto som de har utfärdats i.
För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.
Type:
apiKey
In:
query
SAS Token
Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett säkrare sätt än den delade nyckeln.
För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.
Type:
apiKey
In:
header
Exempel
Successfully retrieve daily indices values from current day
Sample Request
GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query=43.84745,-79.37849&indexGroupId=11
Sample Response
{
"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."
}
]
}
Definitioner
Name | Description |
---|---|
Daily |
Information om ett dagligt index. |
Daily |
Det här objektet returneras från ett lyckat Get Daily Index-anrop. |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Json |
Önskat format för svaret. Endast |
DailyIndex
Information om ett dagligt index.
Name | Typ | Description |
---|---|---|
ascending |
boolean |
Beskriver riktningen för |
category |
string |
Textbeskrivning för |
categoryValue |
integer |
Nivå som indexvärdet faller under, representerat av ett heltal. Det här värdet kan vara 1 till och med 5 och bör användas i kombination med |
dateTime |
string |
Datum och tid för den aktuella observationen visas i ISO 8601-format, till exempel 2019-10-27T19:39:57-08:00. |
description |
string |
En textförklaring som kan användas för visning för att sammanfatta indexvärdet och kategorin. När indexvärdet för flygförseningar till exempel är mycket bra blir beskrivningen "Villkor är utmärkta för att flyga!". |
indexId |
integer |
Numeriskt ID som används för att identifiera det specifika indexet. Mer information finns i Vädertjänster i Azure Maps och för att se de index-ID:er som stöds. Index-ID:t kan till exempel stödja visualiseringsscenarier för användargränssnitt. |
indexName |
string |
Namn på indexet, till exempel "Konstruktion", "Utomhusaktivitet", "Flygförseningar". |
value |
number |
Indexvärde. Sträcker sig från 0,0 till 10,0. Mer information finns i Vädertjänster i Azure Maps och för att se vilka intervall som stöds. |
DailyIndicesResult
Det här objektet returneras från ett lyckat Get Daily Index-anrop.
Name | Typ | Description |
---|---|---|
results |
En lista över alla dagliga index för den efterfrågade platsen. |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Ytterligare information. |
type |
string |
Den ytterligare informationstypen. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
JsonFormat
Önskat format för svaret. Endast json
format stöds.
Name | Typ | Description |
---|---|---|
json |
string |