Timezone - Get Timezone By Coordinates

Użyj polecenia , aby uzyskać bieżące, historyczne i przyszłe informacje o strefie czasowej dla określonej pary długości geograficznej szerokości geograficznej.

Interfejs Get Timezone By Coordinates API to żądanie HTTP GET zwracające bieżące, historyczne i przyszłe informacje o strefie czasowej dla określonej pary długości geograficznej szerokości geograficznej. Ponadto interfejs API zapewnia godziny zachodu słońca i wschodu słońca dla danej lokalizacji.

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}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
format
path True

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko json format.

api-version
query True

string

Numer wersji interfejsu API Azure Maps.

query
query True

number[]

Współrzędne punktu, dla którego są żądane informacje o strefie czasowej. Ten parametr jest listą współrzędnych zawierających parę współrzędnych (lat, long). Gdy ten punkt końcowy jest wywoływany bezpośrednio, współrzędne są przekazywane jako pojedynczy ciąg zawierający współrzędne rozdzielone przecinkami.

options
query

TimezoneOptions

Alternatywnie użyj aliasu "o". Dostępne opcje dla typów informacji zwróconych w wyniku.

timeStamp
query

string

date-time

Alternatywnie należy użyć aliasu "stamp" lub "s". W przypadku pominięcia czasu odwołania interfejs API będzie używać czasu maszyny obsługującej żądanie.

transitionsFrom
query

string

date-time

Alternatywnie użyj aliasu "tf". Data rozpoczęcia, od której są wymagane przejścia czasu letniego (DST), ma zastosowanie tylko wtedy, gdy "opcje" = wszystkie lub "opcje" = przejścia.

transitionsYears
query

integer

Alternatywnie użyj aliasu "ty". Liczba lat od "transitionsFrom", dla których są wymagane przejścia DST, ma zastosowanie tylko wtedy, gdy "opcje" = wszystkie lub "opcje" = przejścia.

Nagłówek żądania

Nazwa Wymagane Typ Opis
x-ms-client-id

string

Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Tożsamość Microsoft Entra. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby użyć zabezpieczeń Tożsamość Microsoft Entra w usłudze Azure Maps, zobacz następujące artykuły, aby uzyskać wskazówki.

Accept-Language

string

Określa kod języka, w którym mają być zwracane nazwy strefy czasowej. Jeśli nie podano kodu językowego, odpowiedź będzie mieć wartość "EN". Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki .

Odpowiedzi

Nazwa Typ Opis
200 OK

TimezoneResult

OK

Other Status Codes

ErrorResponse

Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu OAuth 2.0 Microsoft Entra. W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

  • Ta definicja zabezpieczeń wymaga użycia nagłówkax-ms-client-id, aby wskazać, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje Tożsamość Microsoft Entra. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa Opis
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas Twórca konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST Azure Maps w celu bezpiecznego przechowywania klucza.

Type: apiKey
In: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.

Type: apiKey
In: header

Przykłady

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

Definicje

Nazwa Opis
CountryRecord

Rekord kraju/regionu.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko json format.

ReferenceTime

Szczegóły obowiązują w czasie lokalnym.

RepresentativePoint

Właściwość punktu reprezentatywnego

TimeTransition
TimezoneId
TimezoneNames

Obiekt nazw stref czasowych.

TimezoneOptions

Alternatywnie użyj aliasu "o". Dostępne opcje dla typów informacji zwróconych w wyniku.

TimezoneResult

Ten obiekt jest zwracany z pomyślnego wywołania Timezone By ID lub Według współrzędnych

CountryRecord

Rekord kraju/regionu.

Nazwa Typ Opis
Code

string

ISO-3166 2-literowy kod kraju/regionu dla kraju/regionu.

Name

string

nazwa kraju/regionu

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko json format.

Nazwa Typ Opis
json

string

Format wymiany danych notacji obiektów JavaScript

ReferenceTime

Szczegóły obowiązują w czasie lokalnym.

Nazwa Typ Opis
DaylightSavings

string

Czas oszczędzenia w minutach w ciągu ReferenceUTCTimestamp.

PosixTz

string

Ciąg POSIX używany do ustawiania zmiennej środowiskowej strefy czasowej.

PosixTzValidYear

integer

Rok ten ciąg POSIX jest prawidłowy dla. Uwaga: ciąg POSIX będzie prawidłowy tylko w danym roku.

StandardOffset

string

Przesunięcie czasu UTC w życie o wartości ReferenceUTCTimestamp.

Sunrise

string

Wschód słońca w danej strefie czasowej, jak pokazano we Tag właściwości. Wschód słońca jest opisany w formacie ISO8601. (Należy wypełnić tylko wtedy, gdy wywołanie jest byCoordinates)

Sunset

string

Zachód słońca w danej strefie czasowej, jak pokazano w Tag obiekcie. Zachód słońca jest opisany w formacie ISO8601. (Należy wypełnić tylko wtedy, gdy wywołanie jest byCoordinates)

Tag

string

Nazwa strefy czasowej obowiązuje w sygnaturze czasowej odwołania (tj. PST lub PDT w zależności od tego, czy czas letni jest w mocy).

WallTime

string

Bieżący czas ściany w danej strefie czasowej, jak pokazano we Tag właściwości.

RepresentativePoint

Właściwość punktu reprezentatywnego

Nazwa Typ Opis
Latitude

number

Właściwość Szerokość geograficzna

Longitude

number

Właściwość Długość geograficzna

TimeTransition

Nazwa Typ Opis
DaylightSavings

string

Właściwość DaylightSavings

StandardOffset

string

Właściwość StandardOffset

Tag

string

Właściwość tagu

UtcEnd

string

Data zakończenia, godzina zakończenia dla tego okresu przejściowego

UtcStart

string

Data rozpoczęcia, godzina rozpoczęcia dla tego okresu przejściowego

TimezoneId

Nazwa Typ Opis
Aliases

string[]

Tablica aliasów identyfikatorów strefy czasowej. Zwracane tylko wtedy, gdy [options]=zoneinfo lub wszystkie.

Uwaga: może mieć wartość null.

Countries

CountryRecord[]

Tablica rekordów kraju/regionu. Zwracane tylko wtedy, gdy [options]=zoneinfo lub wszystkie.

Id

string

Właściwość Id

Names

TimezoneNames

Obiekt nazw stref czasowych.

ReferenceTime

ReferenceTime

Szczegóły obowiązują w czasie lokalnym.

RepresentativePoint

RepresentativePoint

Właściwość punktu reprezentatywnego

TimeTransitions

TimeTransition[]

Przejście DST strefy czasowej z [transitionsFrom] do znacznika czasu + 1 rok.

TimezoneNames

Obiekt nazw stref czasowych.

Nazwa Typ Opis
Daylight

string

Nazwa letnia

Generic

string

Nazwa ogólna

ISO6391LanguageCode

string

Kod języka ISO 639-1 nazw

Standard

string

Nazwa standardu

TimezoneOptions

Alternatywnie użyj aliasu "o". Dostępne opcje dla typów informacji zwróconych w wyniku.

Nazwa Typ Opis
all

string

Uwzględnij zarówno informacje o strefie, jak i przejścia w wyniku.

none

string

W wyniku nie należy uwzględniać informacji o strefie ani przejściach.

transitions

string

Uwzględnij informacje o przejściu w wyniku (liczba przejść jest obecnie ograniczona do 250).

zoneInfo

string

Uwzględnij dodatkowe informacje o strefie czasowej w wyniku.

TimezoneResult

Ten obiekt jest zwracany z pomyślnego wywołania Timezone By ID lub Według współrzędnych

Nazwa Typ Opis
ReferenceUtcTimestamp

string

Odwołanie do właściwości znacznika czasu UTC

TimeZones

TimezoneId[]

Tablica TimeZoneId

Version

string

Właściwość version