Timezone - Get Timezone By ID

Referentie

Service:: Maps

API-versie:: 1.0

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

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

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

Met optionele 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` 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. Naslagtijd, indien weggelaten, gebruikt de API de machinetijd die de aanvraag verwerkt.
transitionsFrom	query		string date-time	U kunt ook alias tf gebruiken. De begindatum van waaruit zomertijdovergangen (DST) worden aangevraagd, geldt alleen wanneer "opties" = alle of "opties" = overgangen.
transitionsYears	query		integer	U kunt ook alias 'ty' gebruiken. Het aantal jaren van "transitionsFrom" waarvoor DST-overgangen worden aangevraagd, geldt alleen wanneer "opties" = alle of "opties" = overgangen.

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 Account-API van het Azure Maps-beheervlak. Zie de volgende artikelen voor hulp voor het gebruik van Microsoft Entra ID-beveiliging in Azure Maps.
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 Flows. Wanneer deze is gekoppeld aan 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 aan te wijzen tot een of meer Azure Maps-resourceaccounts of subresources. 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.

Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren 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 uit de Maps Management API-.

De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties. * Het op rollen gebaseerde 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 configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.

Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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 maken in 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 worden uitgegeven.

Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering 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 bewerking List SAS 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 voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Successfully retrieve timezone by ID

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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` indeling wordt ondersteund.
ReferenceTime	Details die van kracht zijn op het lokale tijdstip.
RepresentativePoint	Eigenschap Vertegenwoordigerpunt
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 vanuit een geslaagde tijdzone op id-aanroep of door coördinaten-aanroep

CountryRecord

Een land-/regiorecord.

Name	Type	Description
Code	string	ISO-3166 2-letter land-/regiocode voor het land/de regio.
Name	string	land/regionaam

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

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

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat 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 indeling wordt ondersteund.

Name	Type	Description
json	string	De Notatie Data Interchange-indeling voor JavaScript-objecten

ReferenceTime

Details die van kracht zijn op het lokale tijdstip.

Name	Type	Description
DaylightSavings	string	Tijdbesparing 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 in werking op de `ReferenceUTCTimestamp`.
Sunrise	string	Zonsopgang in de opgegeven tijdzone, zoals weergegeven in de eigenschap `Tag`, alleen ingevuld wanneer de oproep is `byCoordinates`. De zonsopgang wordt beschreven in de ISO 8601 indeling. Houd er rekening mee dat de Tijdzone-API geen zonsopgang- en zonsondergangtijden retourneert wanneer zonnedag wordt waargenomen in de aangevraagde regio.
Sunset	string	Zonsondergang in de opgegeven tijdzone zoals weergegeven in de eigenschap `Tag`, alleen ingevuld wanneer de aanroep `byCoordinates`is. De zonsondergang wordt beschreven in de indeling ISO 8601. Houd er rekening mee dat de Tijdzone-API geen zonsopgang- en zonsondergangtijden retourneert wanneer zonnedag wordt waargenomen in de aangevraagde regio.
Tag	string	De naam van de tijdzone die van kracht is op de referentietijdstempel (d.w. PST of PDT, afhankelijk van of zomertijd van kracht is).
WallTime	string	Huidige wandtijd in de opgegeven tijdzone, zoals wordt weergegeven in de eigenschap `Tag`.

RepresentativePoint

Eigenschap Vertegenwoordigerpunt

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

TimeTransition

Name	Type	Description
DaylightSavings	string	Eigenschap DaylightSavings
StandardOffset	string	Eigenschap StandardOffset
Tag	string	Tageigenschap
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 het lokale tijdstip.
RepresentativePoint	RepresentativePoint	Eigenschap Vertegenwoordigerpunt
TimeTransitions	TimeTransition[]	DST-overgangen van de tijdzone van [transitionsFrom] tot tijdstempel + 1 jaar.

TimezoneNames

Object met tijdzonenamen.

Name	Type	Description
Daylight	string	Daglichtnaam
Generic	string	Soortnaam
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	Voeg aanvullende tijdzonegegevens toe aan het resultaat.

TimezoneResult

Dit object wordt geretourneerd vanuit een geslaagde tijdzone op id-aanroep of door coördinaten-aanroep

Name	Type	Description
ReferenceUtcTimestamp	string	Verwijzing utc tijdstempeleigenschap
TimeZones	TimezoneId[]	TimeZoneId-matrix
Version	string	Versie-eigenschap

Delen via