Timezone - Get Timezone By ID

Referentie

Service:: Maps

API Version:: 1.0

Gebruik om de huidige, historische en toekomstige tijdzonegegevens voor de opgegeven IANA-tijdzone-id op te halen.

De Get Timezone By ID API is een HTTP-aanvraag GET die huidige, historische en toekomstige tijdzonegegevens retourneert voor de opgegeven IANA-tijdzone-id.

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}

URI-parameters

Name	In	Vereist	Type	Description
format	path	True	JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
api-version	query	True	string	Versienummer van Azure Maps API.
query	query	True	string	De IANA-tijdzone-id.
options	query		TimezoneOptions	U kunt ook alias 'o' gebruiken. Beschikbare opties voor typen informatie die in het resultaat worden geretourneerd.
timeStamp	query		string date-time	U kunt ook alias 'stempel' of 's' gebruiken. Referentietijd: als u dit weglaat, gebruikt de API de machinetijd die de aanvraag verwerkt.
transitionsFrom	query		string date-time	U kunt ook alias 'tf' gebruiken. De begindatum vanaf welke overgangen zomertijd (ZOMERTIJD) worden aangevraagd, is alleen van toepassing wanneer 'opties' = alle of 'opties' = overgangen.
transitionsYears	query		integer	U kunt ook de alias 'ty' gebruiken. Het aantal jaren van 'transitionsFrom' waarvoor overgangen voor de DST worden aangevraagd, is alleen van toepassing wanneer 'options' = all of 'options' = transitions.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID-beveiliging in Azure Maps raadpleegt u de volgende artikelen voor hulp.
Accept-Language		string	Hiermee geeft u de taalcode waarin de tijdzonenamen moeten worden geretourneerd. Als er geen taalcode wordt opgegeven, wordt het antwoord weergegeven in 'EN'. Raadpleeg Ondersteunde talen voor meer informatie.

Antwoorden

Name	Type	Description
200 OK	TimezoneResult	OK
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. In combinatie met op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Als u scenario's wilt implementeren, raden we u aan om verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id header om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.

Zie Microsoft identity platform overzicht voor meer informatie over 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

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account Creatie in de Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een shared access signature-token dat wordt gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle over het verloop, de snelheid en de gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

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

Definities

Name	Description
CountryRecord	Een land-/regiorecord.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
ReferenceTime	Details die van kracht zijn op de lokale tijd.
RepresentativePoint	De eigenschap Representatief punt
TimeTransition
TimezoneId
TimezoneNames	Object met tijdzonenamen.
TimezoneOptions	U kunt ook alias 'o' gebruiken. Beschikbare opties voor typen informatie die in het resultaat worden geretourneerd.
TimezoneResult	Dit object wordt geretourneerd na een geslaagde timezone by id-aanroep of op coördinaten-aanroep

CountryRecord

Een land-/regiorecord.

Name	Type	Description
Code	string	ISO-3166 land-/regiocode van 2 letters voor het land/de regio.
Name	string	naam van land/regio

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

JsonFormat

Gewenste indeling van het antwoord. Alleen json de indeling wordt ondersteund.

Name	Type	Description
json	string	De JavaScript Object Notation Data Interchange-indeling

ReferenceTime

Details die van kracht zijn op de lokale tijd.

Name	Type	Description
DaylightSavings	string	Tijdsbesparing in minuten die van kracht zijn op de `ReferenceUTCTimestamp`.
PosixTz	string	POSIX-tekenreeks die wordt gebruikt om de omgevingsvariabele voor de tijdzone in te stellen.
PosixTzValidYear	integer	Het jaar waarvoor deze POSIX-tekenreeks geldig is. Opmerking: een POSIX-tekenreeks is alleen geldig in het opgegeven jaar.
StandardOffset	string	UTC-offset is van kracht op de `ReferenceUTCTimestamp`.
Sunrise	string	Zonsopgang in de opgegeven tijdzone zoals weergegeven in de `Tag` eigenschap. De zonsopgang wordt beschreven in de indeling ISO8601. (Alleen worden ingevuld als de aanroep byCoordinates is)
Sunset	string	Zonsondergang in de opgegeven tijdzone zoals weergegeven in de `Tag` eigenschap. De zonsondergang wordt beschreven in de indeling ISO8601. (Alleen worden ingevuld als de aanroep byCoordinates is)
Tag	string	De tijdzonenaam is van kracht op de referentietijdstempel (dat wil zeggen PST of PDT, afhankelijk van of zomertijd van kracht is).
WallTime	string	Huidige wandtijd in de opgegeven tijdzone, zoals weergegeven in de `Tag` eigenschap.

RepresentativePoint

De eigenschap Representatief punt

Name	Type	Description
Latitude	number	De eigenschap Breedtegraad
Longitude	number	De eigenschap Lengtegraad

TimeTransition

Name	Type	Description
DaylightSavings	string	De eigenschap DaylightSavings
StandardOffset	string	De eigenschap StandardOffset
Tag	string	Tag-eigenschap
UtcEnd	string	Einddatum, eindtijd voor deze overgangsperiode
UtcStart	string	Begindatum, begintijd voor deze overgangsperiode

TimezoneId

Name	Type	Description
Aliases	string[]	Een matrix met tijdzone-id-aliassen. Alleen geretourneerd wanneer [options]=zoneinfo of alle. Opmerking: kan null zijn.
Countries	CountryRecord[]	Een matrix met land-/regiorecords. Alleen geretourneerd wanneer [options]=zoneinfo of alle.
Id	string	Id-eigenschap
Names	TimezoneNames	Object met tijdzonenamen.
ReferenceTime	ReferenceTime	Details die van kracht zijn op de lokale tijd.
RepresentativePoint	RepresentativePoint	De eigenschap Representatief punt
TimeTransitions	TimeTransition[]	Tijdzone DST overgangen van [overgangenVanaf] naar timestamp + 1 jaar.

TimezoneNames

Object met tijdzonenamen.

Name	Type	Description
Daylight	string	Naam van daglicht
Generic	string	Algemene naam
ISO6391LanguageCode	string	De ISO 639-1-taalcode van de namen
Standard	string	Standaardnaam

TimezoneOptions

U kunt ook alias 'o' gebruiken. Beschikbare opties voor typen informatie die in het resultaat worden geretourneerd.

Name	Type	Description
all	string	Neem zowel zoneinfo als overgangen op in het resultaat.
none	string	Neem geen zoneinfo of overgangen op in het resultaat.
transitions	string	Neem overgangsgegevens op in het resultaat (het aantal overgangen is momenteel beperkt tot 250).
zoneInfo	string	Neem aanvullende informatie over de tijdzone op in het resultaat.

TimezoneResult

Dit object wordt geretourneerd na een geslaagde timezone by id-aanroep of op coördinaten-aanroep

Name	Type	Description
ReferenceUtcTimestamp	string	Verwijzing naar de eigenschap Utc Timestamp
TimeZones	TimezoneId[]	TimeZoneId-matrix
Version	string	Versie-eigenschap

Delen via