Timezone - Get Timezone By ID

Reference

Služba:: Maps

Verze rozhraní API:: 1.0

Slouží k získání aktuálních, historických a budoucích informací o časovém pásmu pro zadané ID IANA.

Rozhraní API Get Timezone By ID je požadavek HTTP GET, který vrací aktuální, historické a budoucí informace o časovém pásmu pro zadané ID IANA IANA.

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

S volitelnými parametry:

GET https://atlas.microsoft.com/timezone/byId/json?api-version=1.0&options={options}&timeStamp={timeStamp}&transitionsFrom={transitionsFrom}&transitionsYears={transitionsYears}&query={query}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
format	path	True	JsonFormat	Požadovaný formát odpovědi Podporuje se pouze `json` formát.
api-version	query	True	string	Číslo verze rozhraní API služby Azure Maps
query	query	True	string	ID IANA časového pásma.
options	query		TimezoneOptions	Případně použijte alias "o". Možnosti dostupné pro typy informací vrácených ve výsledku
timeStamp	query		string date-time	Případně můžete použít alias "stamp" nebo "s". Pokud tento parametr vynecháte, použije rozhraní API čas počítače obsluhující požadavek.
transitionsFrom	query		string date-time	Případně použijte alias "tf". Počáteční datum, od kterého jsou požadovány přechody letního času (DST), platí pouze v případě, že "možnosti" = všechny nebo "možnosti" = přechody.
transitionsYears	query		integer	Případně použijte alias "ty". Počet roků od "transitionsFrom", pro které jsou požadovány přechody DST, platí pouze v případě, že "možnosti" = všechny nebo "možnosti" = přechody.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID pro účet Azure Maps a dá se načíst z rozhraní API účtu roviny správy Azure Maps. Informace o používání zabezpečení Microsoft Entra ID v Azure Maps najdete v následujících článcích s pokyny.
Accept-Language		string	Určuje kód jazyka, ve kterém se mají vrátit názvy časových pásem. Pokud není k dispozici žádný kód jazyka, odpověď bude v "EN". Podrobnosti najdete v podporovaných jazycích.

Odpovědi

Name	Typ	Description
200 OK	TimezoneResult	OK
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Zabezpečení

AADToken

Jedná se o Microsoft Entra OAuth 2.0 Flow. Při spárování s přístupu na základě role Azure se dá řídit přístup k rozhraním REST API služby Azure Maps. Řízení přístupu na základě role Azure slouží k určení přístupu k jednomu nebo více účtům prostředků Nebo dílčím prostředkům Azure Maps. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k rozhraním REST API služby Azure Maps.

Pokud chcete implementovat scénáře, doporučujeme zobrazit koncepty ověřování . Stručně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a rozsahy.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení, ke kterému prostředku Azure Maps aplikace žádá o přístup. To lze získat z rozhraní API pro správu Maps.

Authorization URL je specifická pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné adresy URL autorizace a konfigurace MICROSOFT Entra ID. * Řízení přístupu na základě role Azure se konfiguruje z roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad AZURE SDK nebo rozhraní REST API. * Použití webové sady SDK služby Azure Maps umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps na webu Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

Díky tomuto klíči má každá aplikace přístup ke všem rozhraní REST API. Jinými slovy, tento klíč lze použít jako hlavní klíč v účtu, ve který jsou vydány.

U veřejně vystavených aplikací doporučujeme používat důvěrných klientských aplikací přístup k rozhraním REST API služby Azure Maps, aby bylo možné klíč bezpečně uložit.

Typ: apiKey
V: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace Vypsat SAS v prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad SDK Azure nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role Azure a jemně odstupňované řízení vypršení platnosti, rychlosti a oblastí použití pro konkrétní token. Jinými slovy, token SAS lze použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů na prostředku účtu Map omezit zneužití vykreslování a pravidelně obnovovat token SAS.

Typ: apiKey
V: header

Příklady

Successfully retrieve timezone by ID

Ukázkový požadavek

HTTP

GET https://atlas.microsoft.com/timezone/byId/json?api-version=1.0&options=all&query=Asia/Bahrain

Ukázková odpověď

Stavový kód:: 200

{
  "Version": "2018c",
  "ReferenceUtcTimestamp": "2018-01-31T00:03:15.1349348Z",
  "TimeZones": [
    {
      "Id": "Asia/Qatar",
      "Aliases": [
        "Asia/Bahrain"
      ],
      "Countries": [
        {
          "Name": "Qatar",
          "Code": "QA"
        },
        {
          "Name": "Bahrain",
          "Code": "BH"
        }
      ],
      "Names": {
        "ISO6391LanguageCode": "en",
        "Generic": "Arabian Time",
        "Standard": "Arabian Standard Time",
        "Daylight": "Arabian Daylight Time"
      },
      "ReferenceTime": {
        "Tag": "+03",
        "StandardOffset": "03:00:00",
        "DaylightSavings": "00:00:00",
        "WallTime": "2018-01-31T03:03:15.1349348+03:00",
        "PosixTzValidYear": 2018,
        "PosixTz": "<+03>-3"
      },
      "RepresentativePoint": {
        "Latitude": 25.283333333333335,
        "Longitude": 51.53333333333333
      },
      "TimeTransitions": [
        {
          "Tag": "+03",
          "StandardOffset": "03:00:00",
          "DaylightSavings": "00:00:00",
          "UtcStart": "1972-05-31T20:00:00Z",
          "UtcEnd": "9999-12-31T23:59:59.9999999Z"
        }
      ]
    }
  ]
}

Definice

Name	Description
CountryRecord	Záznam země/oblasti.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
JsonFormat	Požadovaný formát odpovědi Podporuje se pouze `json` formát.
ReferenceTime	Podrobnosti, které se projeví v místním čase
RepresentativePoint	Vlastnost reprezentativního bodu
TimeTransition
TimezoneId
TimezoneNames	Objekt názvů časových pásem
TimezoneOptions	Případně použijte alias "o". Možnosti dostupné pro typy informací vrácených ve výsledku
TimezoneResult	Tento objekt se vrátí z úspěšného volání Timezone By ID nebo volání podle souřadnic.

CountryRecord

Záznam země/oblasti.

Name	Typ	Description
Code	string	ISO-3166 2-letter country/region code for the country/region code for the country/region.
Name	string	country/region Name

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

JsonFormat

Požadovaný formát odpovědi Podporuje se pouze json formát.

Name	Typ	Description
json	string	formát výměny dat javascriptového objektu

ReferenceTime

Podrobnosti, které se projeví v místním čase

Name	Typ	Description
DaylightSavings	string	Úspora času v minutách v `ReferenceUTCTimestamp`.
PosixTz	string	Řetězec POSIX použitý k nastavení proměnné prostředí časového pásma
PosixTzValidYear	integer	Rok, pro který je tento řetězec POSIX platný. Poznámka: Řetězec POSIX bude platný pouze v daném roce.
StandardOffset	string	Posun UTC v `ReferenceUTCTimestamp`.
Sunrise	string	Východ slunce v daném časovém pásmu, jak je znázorněno ve vlastnosti `Tag`, naplněno pouze v případě, že je volání `byCoordinates`. Východ slunce je popsán ve formátu ISO 8601. Všimněte si, že rozhraní API časového pásma nevrací časy východů a západu slunce, když je v požadované oblasti pozorován sluneční den.
Sunset	string	Západ slunce v daném časovém pásmu, jak je znázorněno ve vlastnosti `Tag`, naplněno pouze v případě, že je volání `byCoordinates`. Západ slunce je popsán ve formátu ISO 8601. Všimněte si, že rozhraní API časového pásma nevrací časy východů a západu slunce, když je v požadované oblasti pozorován sluneční den.
Tag	string	Název časového pásma se projeví v referenčním časovém razítku (tj. PST nebo PDT v závislosti na tom, jestli se používá letní čas).
WallTime	string	Aktuální čas zdi v daném časovém pásmu, jak je znázorněno v `Tag` vlastnosti.

RepresentativePoint

Vlastnost reprezentativního bodu

Name	Typ	Description
Latitude	number	Vlastnost Zeměpisná šířka
Longitude	number	Zeměpisná délka – vlastnost

TimeTransition

Name	Typ	Description
DaylightSavings	string	DaylightSavings – vlastnost
StandardOffset	string	Vlastnost StandardOffset
Tag	string	Vlastnost značky
UtcEnd	string	Koncové datum, koncový čas pro toto přechodné období
UtcStart	string	Počáteční datum, počáteční čas pro toto přechodné období

TimezoneId

Name	Typ	Description
Aliases	string[]	Pole aliasů ID časového pásma. Vrátí se pouze v případech, kdy [options]=zoneinfo nebo všechny. Poznámka: může mít hodnotu null.
Countries	CountryRecord[]	Pole záznamů země/oblasti. Vrátí se pouze v případech, kdy [options]=zoneinfo nebo všechny.
Id	string	Vlastnost ID
Names	TimezoneNames	Objekt názvů časových pásem
ReferenceTime	ReferenceTime	Podrobnosti, které se projeví v místním čase
RepresentativePoint	RepresentativePoint	Vlastnost reprezentativního bodu
TimeTransitions	TimeTransition[]	Přechody DST časových pásem z [transitionsFrom] do časového razítka + 1 rok.

TimezoneNames

Objekt názvů časových pásem

Name	Typ	Description
Daylight	string	Název letního dne
Generic	string	Obecný název
ISO6391LanguageCode	string	Kód jazyka ISO 639-1 názvů
Standard	string	Standardní název

TimezoneOptions

Případně použijte alias "o". Možnosti dostupné pro typy informací vrácených ve výsledku

Name	Typ	Description
all	string	Do výsledku zahrňte informace o zóně i přechody.
none	string	Do výsledku nezahrnujte informace o zóně ani přechody.
transitions	string	Zahrnout informace o přechodu do výsledku (počet přechodů je aktuálně omezen na 250).
zoneInfo	string	Do výsledku uveďte další informace o časovém pásmu.

TimezoneResult

Tento objekt se vrátí z úspěšného volání Timezone By ID nebo volání podle souřadnic.

Name	Typ	Description
ReferenceUtcTimestamp	string	Reference Utc Timestamp – vlastnost
TimeZones	TimezoneId[]	Pole TimeZoneId
Version	string	Vlastnost Verze

Sdílet prostřednictvím