Timezone - Get Timezone By ID

Reference

Service:: Maps

API Version:: 1.0

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

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

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

With optional parameters:

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 Azure Maps.
query	query	True	string	ID IANA časového pásma.
options	query		TimezoneOptions	Případně můžete použít alias "o". Dostupné možnosti pro typy informací vrácené ve výsledku
timeStamp	query		string date-time	Případně můžete použít alias "stamp" nebo "s". Referenční čas. Pokud je tento čas vynechán, rozhraní API použije čas počítače obsluhující požadavek.
transitionsFrom	query		string date-time	Případně můžete použít 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še nebo "možnosti" = přechody.
transitionsYears	query		integer	Případně použijte alias "ty". Počet let 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 účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích.
Accept-Language		string	Určuje kód jazyka, ve kterém se mají vrátit názvy časových pásem. Pokud kód jazyka nezadáte, odpověď bude v "CS". Podrobnosti najdete v části Podporované jazyky .

Odpovědi

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

Zabezpečení

AADToken

Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. 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 Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně ř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 obory.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.

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

Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.

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

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

S tímto klíčem může každá aplikace přistupovat ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve kterému je vystavený.

U veřejně vystavených aplikací doporučujeme pro přístup k Azure Maps rozhraní REST API použít přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.

Type: apiKey
In: query

SAS Token

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

S tímto tokenem má každá aplikace autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečeným způsobem než sdílený klíč.

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

Type: apiKey
In: header

Příklady

Successfully retrieve timezone by ID

Sample Request

HTTP

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

Sample Response

Status code:: 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é platí v místním čase.
RepresentativePoint	Vlastnost reprezentativního bodu
TimeTransition
TimezoneId
TimezoneNames	Objekt názvů časových pásem.
TimezoneOptions	Případně můžete použít alias "o". Dostupné možnosti pro typy informací vrácené ve výsledku
TimezoneResult	Tento objekt se vrátí z úspěšného volání Timezone By ID nebo By Coordinates.

CountryRecord

Záznam země/oblasti.

Name	Typ	Description
Code	string	ISO-3166 – 2mísmenný kód země/oblasti pro zemi/oblast
Name	string	country/region Name

ErrorAdditionalInfo

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

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

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 zápisu objektů JavaScriptu

ReferenceTime

Podrobnosti, které platí v místním čase.

Name	Typ	Description
DaylightSavings	string	Úspora času v minutách při `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	Odsazení UTC v platnosti v .`ReferenceUTCTimestamp`
Sunrise	string	Východ slunce v daném časovém pásmu, jak je znázorněno `Tag` ve vlastnosti. Východ slunce je popsán ve formátu ISO8601. (Vyplní se pouze v případě, že volání je byCoordinates)
Sunset	string	Západ slunce v daném časovém pásmu, jak je znázorněno `Tag` ve vlastnosti . Západ slunce je popsán ve formátu ISO8601. (Vyplní se pouze v případě, že volání je byCoordinates)
Tag	string	Název časového pásma, který je v platnosti 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 `Tag` ve 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 a čas ukončení tohoto přechodného období
UtcStart	string	Počáteční datum, čas začátku tohoto přechodného období

TimezoneId

Name	Typ	Description
Aliases	string[]	Pole aliasů ID časového pásma. Vrátí se pouze v případě, že [options]=zoneinfo nebo vše. Poznámka: Může mít hodnotu null.
Countries	CountryRecord[]	Pole záznamů země/oblasti. Vrátí se pouze v případě, že [options]=zoneinfo nebo vše.
Id	string	Vlastnost Id
Names	TimezoneNames	Objekt názvů časových pásem.
ReferenceTime	ReferenceTime	Podrobnosti, které platí v místním čase.
RepresentativePoint	RepresentativePoint	Vlastnost reprezentativního bodu
TimeTransitions	TimeTransition[]	Přechody DST v časovém pásmu od [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ě můžete použít alias "o". Dostupné možnosti pro typy informací vrácené ve výsledku

Name	Typ	Description
all	string	Do výsledku zahrňte zoneinfo i přechody.
none	string	Do výsledku nezahrnujte zoneinfo ani přechody.
transitions	string	Do výsledku zahrňte informace o přechodu (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 By Coordinates.

Name	Typ	Description
ReferenceUtcTimestamp	string	Referenční vlastnost časového razítka UTC
TimeZones	TimezoneId[]	Pole TimeZoneId
Version	string	Vlastnost Version