Timezone - Get Timezone By Coordinates
Använd för att hämta aktuell, historisk och framtida tidszonsinformation för det angivna latitud-longitudparet.
API:et Get Timezone By Coordinates
är en HTTP-begäran GET
som returnerar aktuell, historisk och framtida tidszonsinformation för ett angivet latitud-longitudpar. Dessutom tillhandahåller API:et solnedgångs- och soluppgångstider för en viss plats.
GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&query={query}
GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&options={options}&timeStamp={timeStamp}&transitionsFrom={transitionsFrom}&transitionsYears={transitionsYears}&query={query}
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
format
|
path | True |
Json |
Önskat format för svaret. Endast |
api-version
|
query | True |
string |
Versionsnummer för Azure Maps API. |
query
|
query | True |
number[] |
Koordinater för den punkt där tidszonsinformation begärs. Den här parametern är en lista över koordinater som innehåller ett koordinatpar (lat, long). När den här slutpunkten anropas direkt skickas koordinaterna in som en enda sträng som innehåller koordinater, avgränsade med kommatecken. |
options
|
query |
Timezone |
Du kan också använda aliaset "o". Tillgängliga alternativ för typer av information som returneras i resultatet. |
|
time
|
query |
string date-time |
Du kan också använda aliaset "stamp" eller "s". Om referenstiden utelämnas använder API:et den datortid som betjänar begäran. |
|
transitions
|
query |
string date-time |
Du kan också använda aliaset "tf". Startdatumet från vilket sommartidsövergångar (DST) begärs, gäller endast när "alternativ" = alla eller "alternativ" = övergångar. |
|
transitions
|
query |
integer |
Du kan också använda aliaset "ty". Antalet år från "transitionsFrom" som DST-övergångar begärs för, gäller endast när "alternativ" = alla eller "alternativ" = övergångar. |
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. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps hanteringsplans konto-API. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar. |
|
Accept-Language |
string |
Anger språkkoden där tidszonsnamnen ska returneras. Om ingen språkkod anges anges svaret i "EN". Mer information finns i Språk som stöds . |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Timezone |
OK |
Other Status Codes |
Error |
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 en 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 få å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 Management-API:et.
Authorization URL
är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer.
* Den rollbaserade Azure-åtkomstkontrollen 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 skapar ett Azure Maps-konto i Azure Portal eller använder 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 en huvudnyckel i det konto som de utfärdas 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 mer säkert 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 återgivningsmissbruk och regelbundet förnya SAS-token.
Type:
apiKey
In:
header
Exempel
Successfully retrieve timezone by coordinates
Sample Request
GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&options=all&query=47,-122
Sample Response
{
"Version": "2019a",
"ReferenceUtcTimestamp": "2019-06-17T22:16:59.0765556Z",
"TimeZones": [
{
"Id": "America/Los_Angeles",
"Aliases": [
"US/Pacific",
"US/Pacific-New"
],
"Countries": [
{
"Name": "United States",
"Code": "US"
}
],
"Names": {
"ISO6391LanguageCode": "en",
"Generic": "Pacific Time",
"Standard": "Pacific Standard Time",
"Daylight": "Pacific Daylight Time"
},
"ReferenceTime": {
"Tag": "PDT",
"StandardOffset": "-08:00:00",
"DaylightSavings": "01:00:00",
"WallTime": "2019-06-17T15:16:59.0765556-07:00",
"PosixTzValidYear": 2019,
"PosixTz": "PST+8PDT,M3.2.0,M11.1.0",
"Sunrise": "2019-06-17T05:12:21.267-07:00",
"Sunset": "2019-06-17T21:05:18.017-07:00"
},
"RepresentativePoint": {
"Latitude": 34.05222222222222,
"Longitude": -118.24277777777777
},
"TimeTransitions": [
{
"Tag": "PDT",
"StandardOffset": "-08:00:00",
"DaylightSavings": "01:00:00",
"UtcStart": "2019-03-10T10:00:00Z",
"UtcEnd": "2019-11-03T09:00:00Z"
},
{
"Tag": "PST",
"StandardOffset": "-08:00:00",
"DaylightSavings": "00:00:00",
"UtcStart": "2019-11-03T09:00:00Z",
"UtcEnd": "2020-03-08T10:00:00Z"
},
{
"Tag": "PDT",
"StandardOffset": "-08:00:00",
"DaylightSavings": "01:00:00",
"UtcStart": "2020-03-08T10:00:00Z",
"UtcEnd": "2020-11-01T09:00:00Z"
}
]
}
]
}
Definitioner
Name | Description |
---|---|
Country |
En lands-/regionpost. |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Json |
Önskat format för svaret. Endast |
Reference |
Information som gäller vid den lokala tidpunkten. |
Representative |
Egenskap för representativ punkt |
Time |
|
Timezone |
|
Timezone |
Objekt för tidszonsnamn. |
Timezone |
Du kan också använda aliaset "o". Tillgängliga alternativ för typer av information som returneras i resultatet. |
Timezone |
Det här objektet returneras från ett lyckat Tidszon efter ID-anrop eller anrop av koordinater |
CountryRecord
En lands-/regionpost.
Name | Typ | Description |
---|---|---|
Code |
string |
ISO-3166 2-bokstavs lands-/regionkod för land/region. |
Name |
string |
land/regionnamn |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Den ytterligare informationen. |
type |
string |
Ytterligare informationstyp. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Error |
Ytterligare information om felet. |
code |
string |
Felkoden. |
details |
Error |
Felinformationen. |
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Error |
Felobjektet. |
JsonFormat
Önskat format för svaret. Endast json
format stöds.
Name | Typ | Description |
---|---|---|
json |
string |
ReferenceTime
Information som gäller vid den lokala tidpunkten.
Name | Typ | Description |
---|---|---|
DaylightSavings |
string |
Tidsbesparing i minuter som gäller vid |
PosixTz |
string |
POSIX-sträng som används för att ange tidszonsmiljövariabeln. |
PosixTzValidYear |
integer |
Det år som POSIX-strängen är giltig för. Obs! En POSIX-sträng är endast giltig under det angivna året. |
StandardOffset |
string |
UTC-förskjutning i praktiken vid |
Sunrise |
string |
Soluppgång vid den angivna tidszonen enligt vad som visas i egenskapen |
Sunset |
string |
Solnedgång vid den angivna tidszonen enligt vad |
Tag |
string |
Tidszonens namn som gäller vid referenstidsstämpeln (dvs. PST eller PDT beroende på om sommartid är aktiv). |
WallTime |
string |
Aktuell väggtid vid den angivna tidszonen |
RepresentativePoint
Egenskap för representativ punkt
Name | Typ | Description |
---|---|---|
Latitude |
number |
Latitude-egenskap |
Longitude |
number |
Longitudegenskap |
TimeTransition
Name | Typ | Description |
---|---|---|
DaylightSavings |
string |
Egenskapen DaylightSavings |
StandardOffset |
string |
Egenskapen StandardOffset |
Tag |
string |
Taggegenskap |
UtcEnd |
string |
Slutdatum, sluttid för den här övergångsperioden |
UtcStart |
string |
Startdatum, starttid för den här övergångsperioden |
TimezoneId
Name | Typ | Description |
---|---|---|
Aliases |
string[] |
En matris med tidszons-ID-alias. Returneras endast när [alternativ]=zoneinfo eller alla. Obs! Kan vara null. |
Countries |
Country |
En matris med poster för land/region. Returneras endast när [alternativ]=zoneinfo eller alla. |
Id |
string |
Id-egenskap |
Names |
Timezone |
Objekt för tidszonsnamn. |
ReferenceTime |
Reference |
Information som gäller vid den lokala tidpunkten. |
RepresentativePoint |
Representative |
Egenskap för representativ punkt |
TimeTransitions |
Time |
Tidszonens DST övergår från [transitionsFrom] till tidsstämpel + 1 år. |
TimezoneNames
Objekt för tidszonsnamn.
Name | Typ | Description |
---|---|---|
Daylight |
string |
Namn på sommartid |
Generic |
string |
Allmänt namn |
ISO6391LanguageCode |
string |
Iso 639-1-språkkoden för namn |
Standard |
string |
Standardnamn |
TimezoneOptions
Du kan också använda aliaset "o". Tillgängliga alternativ för typer av information som returneras i resultatet.
Name | Typ | Description |
---|---|---|
all |
string |
Inkludera både zoneinfo och övergångar i resultatet. |
none |
string |
Ta inte med zoneinfo eller övergångar i resultatet. |
transitions |
string |
Inkludera övergångsinformation i resultatet (Antalet övergångar är för närvarande begränsat till 250). |
zoneInfo |
string |
Inkludera ytterligare tidszonsinformation i resultatet. |
TimezoneResult
Det här objektet returneras från ett lyckat Tidszon efter ID-anrop eller anrop av koordinater
Name | Typ | Description |
---|---|---|
ReferenceUtcTimestamp |
string |
Referensegenskap för Tidsstämpel för Utc |
TimeZones |
Timezone |
TimeZoneId-matris |
Version |
string |
Versionsegenskap |