Timezone - Get Timezone By ID

Referens

Tjänst:: Maps

API-version:: 1.0

Använd för att hämta aktuell, historisk och framtida tidszonsinformation för det angivna IANA-tidszons-ID:t.

Get Timezone By ID-API:et är en HTTP-GET begäran som returnerar aktuell, historisk och framtida tidszonsinformation för angivet IANA-tidszons-ID.

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

Med valfria parametrar:

GET https://atlas.microsoft.com/timezone/byId/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	JsonFormat	Önskat format för svaret. Endast `json` format stöds.
api-version	query	True	string	Versionsnummer för Azure Maps API.
query	query	True	string	IANA-tidszons-ID.
options	query		TimezoneOptions	Du kan också använda aliaset "o". Tillgängliga alternativ för typer av information som returneras i resultatet.
timeStamp	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.
transitionsFrom	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.
transitionsYears	query		integer	Alternativt kan du använda aliaset "ty". Antalet år från "transitionsFrom" för vilka DST-övergångar begärs, 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äkerhetsmodellen. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar för vägledning.
Accept-Language		string	Anger språkkoden där tidszonsnamnen ska returneras. Om ingen språkkod anges visas svaret i "EN". Mer information finns i språk som stöds.

Svar

Name	Typ	Description
200 OK	TimezoneResult	OKEJ
Other Status Codes	ErrorResponse	Ett oväntat fel uppstod.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll 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 ett eller flera Azure Maps-resurskonton 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 till 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.

Anteckningar

Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et.

Authorization URL är specifik för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer. * Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, 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 Översikt över Microsofts identitetsplattform.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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 Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST API:er. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder konfidentiella klientprogram metod för åtkomst till Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Typ: apiKey
I: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, 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 till 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 återgivningsmissbruket och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Successfully retrieve timezone by ID

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
CountryRecord	En post för land/region.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
JsonFormat	Önskat format för svaret. Endast `json` format stöds.
ReferenceTime	Information som gäller vid den lokala tidpunkten.
RepresentativePoint	Representativ punktegenskap
TimeTransition
TimezoneId
TimezoneNames	Objekt för tidszonsnamn.
TimezoneOptions	Du kan också använda aliaset "o". Tillgängliga alternativ för typer av information som returneras i resultatet.
TimezoneResult	Det här objektet returneras från ett lyckat tidszons-ID-anrop eller anrop av koordinater

CountryRecord

En post för land/region.

Name	Typ	Description
Code	string	ISO-3166 2-bokstavs lands-/regionkod för landet/regionen.
Name	string	country/region Name

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

JsonFormat

Önskat format för svaret. Endast json format stöds.

Name	Typ	Description
json	string	JavaScript-objekt notationens datautbytesformat

ReferenceTime

Information som gäller vid den lokala tidpunkten.

Name	Typ	Description
DaylightSavings	string	Tidsbesparing i minuter som gäller vid `ReferenceUTCTimestamp`.
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 som gäller vid `ReferenceUTCTimestamp`.
Sunrise	string	Soluppgång vid den angivna tidszonen enligt vad som visas i egenskapen `Tag`, som endast fylls i när anropet är `byCoordinates`. Soluppgången beskrivs i ISO 8601 format. Observera att tidszons-API:et inte returnerar tider för soluppgång och solnedgång när soldagen observeras i den begärda regionen.
Sunset	string	Solnedgång vid den angivna tidszonen enligt vad som visas i egenskapen `Tag`, som endast fylls i när anropet är `byCoordinates`. Solnedgången beskrivs i ISO 8601 format. Observera att tidszons-API:et inte returnerar tider för soluppgång och solnedgång när soldagen observeras i den begärda regionen.
Tag	string	Tidszonsnamn som gäller vid referenstidsstämpeln (dvs. PST eller PDT beroende på om sommartid är i kraft).
WallTime	string	Aktuell väggtid vid den angivna tidszonen enligt vad som visas i egenskapen `Tag`.

RepresentativePoint

Representativ punktegenskap

Name	Typ	Description
Latitude	number	Latitude-egenskap
Longitude	number	Longitudegenskap

TimeTransition

Name	Typ	Description
DaylightSavings	string	Egenskapen DaylightSavings
StandardOffset	string	StandardOffset-egenskap
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	CountryRecord[]	En matris med lands-/regionposter. Returneras endast när [alternativ]=zoneinfo eller alla.
Id	string	ID-egenskap
Names	TimezoneNames	Objekt för tidszonsnamn.
ReferenceTime	ReferenceTime	Information som gäller vid den lokala tidpunkten.
RepresentativePoint	RepresentativePoint	Representativ punktegenskap
TimeTransitions	TimeTransition[]	Tidszon DST övergår från [övergångarFrån] 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 namnen
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	Inkludera inte 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 tidszons-ID-anrop eller anrop av koordinater

Name	Typ	Description
ReferenceUtcTimestamp	string	Referera till utc-tidsstämpelegenskap
TimeZones	TimezoneId[]	TimeZoneId-matris
Version	string	Versionsegenskap

Dela via