Timezone - Get Timezone By Coordinates

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.0

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

Interfejs API Get Timezone By Coordinates to żądanie GET HTTP, które zwraca 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 czas zachodu słońca i słońca dla danej lokalizacji, z wyjątkiem regionów, które obserwują dni słoneczne.

GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&query={query}

Z parametrami opcjonalnymi:

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 format `json`.
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps.
query	query	True	number[]	Współrzędne punktu, dla którego żądano informacji 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 oddzielone przecinkami.
options	query		TimezoneOptions	Alternatywnie użyj aliasu "o". Dostępne opcje dla typów informacji zwracanych w wyniku.
timeStamp	query		string date-time	Alternatywnie użyj aliasu "stamp" lub "s". Czas odwołania, jeśli zostanie pominięty, interfejs API będzie używać czasu maszyny obsługującego żą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ą żądane 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ń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń identyfikatora Entra firmy Microsoft 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 powinny być zwracane nazwy strefy czasowej. Jeśli nie podano kodu języka, odpowiedź będzie znajdować się w "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 Microsoft Entra OAuth 2.0. Po połączeniu z dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi mogą mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.

Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera 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.

Notatki

Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania usługami Maps.

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

Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Microsoft identity platform overview.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

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

subscription-key

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

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

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie poufnych aplikacji klienckich podejście do uzyskiwania dostępu do interfejsów API REST usługi Azure Maps, aby klucz mógł być bezpiecznie przechowywany.

Typ: apiKey
W: query

SAS Token

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

Dzięki temu tokenowi 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 SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.

Typ: apiKey
W: header

Przykłady

Successfully retrieve timezone by coordinates

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&options=all&query=47,-122

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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 format `json`.
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 zwracanych w wyniku.
TimezoneResult	Ten obiekt jest zwracany z pomyślnego wywołania timezone według identyfikatora lub wywołania Współrzędnych

CountryRecord

Rekord kraju/regionu.

Nazwa	Typ	Opis
Code	string	Kod kraju/regionu ISO-3166 2-literowy 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 format json.

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	Oszczędność czasu w ciągu kilku minut w `ReferenceUTCTimestamp`.
PosixTz	string	Ciąg POSIX używany do ustawiania zmiennej środowiskowej strefy czasowej.
PosixTzValidYear	integer	Rok ten ciąg POSIX jest prawidłowy. Uwaga: ciąg POSIX będzie prawidłowy tylko w danym roku.
StandardOffset	string	Przesunięcie czasu UTC w czasie `ReferenceUTCTimestamp`.
Sunrise	string	Wschód słońca w danej strefie czasowej, jak pokazano we właściwości `Tag`, wypełniane tylko wtedy, gdy wywołanie jest `byCoordinates`. Wschód słońca jest opisany w formacie ISO 8601. Należy pamiętać, że interfejs API strefy czasowej nie zwraca czasów słońca i zachodu słońca, gdy dzień słoneczny jest obserwowany w żądanym regionie.
Sunset	string	Zachód słońca w danej strefie czasowej, jak pokazano we właściwości `Tag`, wypełniane tylko wtedy, gdy wywołanie jest `byCoordinates`. Zachód słońca jest opisany w formacie ISO 8601. Należy pamiętać, że interfejs API strefy czasowej nie zwraca czasów słońca i zachodu słońca, gdy dzień słoneczny jest obserwowany w żądanym regionie.
Tag	string	Nazwa strefy czasowej obowiązującą w sygnaturze czasowej odwołania (tj. PST lub PDT w zależności od tego, czy czas letni jest obowiązywać).
WallTime	string	Bieżąca godzina ściany w danej strefie czasowej, jak pokazano we właściwości `Tag`.

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 Standardowa

TimezoneOptions

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

Nazwa	Typ	Opis
all	string	Uwzględnij w wyniku zarówno informacje o strefie, jak i przejścia.
none	string	Nie dołączaj informacji o strefie ani przejść w wyniku.
transitions	string	Uwzględnij informacje o przejściu w wyniku (liczba przejść jest obecnie ograniczona do 250).
zoneInfo	string	Dołącz dodatkowe informacje o strefie czasowej w wyniku.

TimezoneResult

Ten obiekt jest zwracany z pomyślnego wywołania timezone według identyfikatora lub wywołania Współrzędnych

Nazwa	Typ	Opis
ReferenceUtcTimestamp	string	Odwołuj się do właściwości znacznika czasu Utc
TimeZones	TimezoneId[]	Tablica TimeZoneId
Version	string	Właściwość Version

Udostępnij za pośrednictwem