Timezone - Get Timezone By Coordinates

Verwenden Sie diese Option, um die aktuellen, historischen und zukünftigen Zeitzoneninformationen für das angegebene Breitengrad-Längengrad-Paar abzurufen.
Die Get Timezone By Coordinates-API ist eine HTTP-GET-Anforderung, die aktuelle, historische und zukünftige Zeitzoneninformationen für ein angegebenes Breiten-Längen-Längengrad-Paar zurückgibt. Darüber hinaus bietet die API Sonnenuntergangs- und Sonnenaufgangszeiten für einen bestimmten Ort, mit Ausnahme von Regionen, die Sonnentage beobachten.

GET {endpoint}/timezone/byCoordinates/json?api-version=1.0&query={query}
GET {endpoint}/timezone/byCoordinates/json?api-version=1.0&options={options}&timeStamp={timeStamp}&transitionsFrom={transitionsFrom}&transitionsYears={transitionsYears}&query={query}

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string (uri)

Der Hostname des Azure Maps-Dienstes. Verwenden Sie https://atlas.microsoft.com für die Azure Public Cloud. Um eine bestimmte Azure Maps Geografie oder eine souveräne Cloud anzusprechen, siehe Azure Maps geografischer Umfang.

format
path True

JsonFormat

Gewünschtes Format der Antwort. Nur json Format wird unterstützt.

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

query
query True

number[]

Koordinaten des Punkts, an dem Zeitzoneninformationen angefordert werden. Dieser Parameter ist eine Liste der Koordinaten, die ein Koordinatenpaar (lat, long) enthalten. Wenn dieser Endpunkt direkt aufgerufen wird, werden Koordinaten als einzelne Zeichenfolge übergeben, die Koordinaten enthält, getrennt durch Kommas.

options
query

TimezoneOptions

Alternativ können Sie alias "o" verwenden. Optionen, die für Typen von Informationen verfügbar sind, die im Ergebnis zurückgegeben werden.

timeStamp
query

string (date-time)

Alternativ können Sie alias "stamp" oder "s" verwenden. Wenn dies nicht angegeben wird, verwendet die API die Computerzeit für die Anforderung.

transitionsFrom
query

string (date-time)

Alternativ können Sie alias "tf" verwenden. Das Startdatum, ab dem Sommerzeitübergänge (DST) angefordert werden, gilt nur, wenn "options" = all or "options" = transitions.

transitionsYears
query

integer (int32)

Alternativ können Sie alias "ty" verwenden. Die Anzahl der Jahre ab "transitionsFrom", für die DST-Übergänge angefordert werden, gilt nur, wenn "options" = all or "options" = transitions.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-id

string

Gibt das Konto an, das für die Nutzung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Diese eindeutige ID für das Azure Maps-Konto kann aus der Azure Maps Management-Plane-Konto-API abgerufen werden. Weitere Informationen zur Nutzung Microsoft Entra ID Sicherheit in Azure Maps finden Sie unter Authentifizierung verwalten in Azure Maps.

Accept-Language

string

Gibt den Sprachcode an, in dem die Zeitzonennamen zurückgegeben werden sollen. Wenn kein Sprachcode angegeben wird, befindet sich die Antwort in "EN". Weitere Informationen finden Sie unter unterstützten Sprachen.

Antworten

Name Typ Beschreibung
200 OK

TimezoneResult

Die Anforderung ist erfolgreich.

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

AadToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. In Kombination mit Azure rollenbasierten Zugriffs Steuerung kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Azure-rollenbasierte Zugriffskontrollen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

Note

  • Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id-Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Karten-Verwaltungs-APIerworben werden.
  • Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über einzigartige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen.
  • Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
  • Die Verwendung des Azure Maps Web SDK ermöglicht das konfigurationsbasierte Einrichten einer Anwendung für mehrere Anwendungsfälle.
  • Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

subscription-key

Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.

Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: header

SAS Token

Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und feinkörniger Kontrolle auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token autorisiert. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen das Steuern des Zugriffs auf eine sicherere Weise zu ermöglichen als der freigegebene Schlüssel.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Successfully retrieve timezone by coordinates

Beispielanforderung

GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&options=all&query=47,-122

Beispiel für eine Antwort

{
  "referenceUtcTimestamp": "2019-06-17T22:16:59.0765556Z",
  "timeZones": [
    {
      "aliases": [
        "US/Pacific",
        "US/Pacific-New"
      ],
      "countries": [
        {
          "code": "US",
          "name": "United States"
        }
      ],
      "id": "America/Los_Angeles",
      "names": {
        "daylight": "Pacific Daylight Time",
        "generic": "Pacific Time",
        "iso6391LanguageCode": "en",
        "standard": "Pacific Standard Time"
      },
      "referenceTime": {
        "daylightSavings": "01:00:00",
        "posixTz": "PST+8PDT,M3.2.0,M11.1.0",
        "posixTzValidYear": 2019,
        "standardOffset": "-08:00:00",
        "sunrise": "2019-06-17T05:12:21.267-07:00",
        "sunset": "2019-06-17T21:05:18.017-07:00",
        "tag": "PDT",
        "wallTime": "2019-06-17T15:16:59.0765556-07:00"
      },
      "representativePoint": {
        "latitude": 34.05222222222222,
        "longitude": -118.24277777777777
      },
      "timeTransitions": [
        {
          "daylightSavings": "01:00:00",
          "standardOffset": "-08:00:00",
          "tag": "PDT",
          "utcEnd": "2019-11-03T09:00:00Z",
          "utcStart": "2019-03-10T10:00:00Z"
        },
        {
          "daylightSavings": "00:00:00",
          "standardOffset": "-08:00:00",
          "tag": "PST",
          "utcEnd": "2020-03-08T10:00:00Z",
          "utcStart": "2019-11-03T09:00:00Z"
        },
        {
          "daylightSavings": "01:00:00",
          "standardOffset": "-08:00:00",
          "tag": "PDT",
          "utcEnd": "2020-11-01T09:00:00Z",
          "utcStart": "2020-03-08T10:00:00Z"
        }
      ]
    }
  ],
  "version": "2019a"
}

Definitionen

Name Beschreibung
CountryRecord

Ein Länder-/Regionsdatensatz.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

JsonFormat

Gewünschtes Format der Antwort. Nur json Format wird unterstützt.

ReferenceTime

Details, die zur Ortszeit wirksam sind.

RepresentativePoint

Repräsentative Point-Eigenschaft

TimeTransition

Stellt einen Zeitzonenwechsel dar.

TimezoneId

Zeitzonen-ID-Informationen.

TimezoneNames

Objekt für Zeitzonennamen.

TimezoneOptions

Optionen für Zeitzoneninformationen wurden im Ergebnis angezeigt.

TimezoneResult

Dieses Objekt wird von einem erfolgreichen Timezone By ID-Aufruf oder von Koordinatenaufruf zurückgegeben.

CountryRecord

Ein Länder-/Regionsdatensatz.

Name Typ Beschreibung
code

string

ISO-3166 2-Buchstaben-Länder-/Regionscode für das Land/die Region.

name

string

Name des Landes/der Region

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

JsonFormat

Gewünschtes Format der Antwort. Nur json Format wird unterstützt.

Wert Beschreibung
json

das JavaScript Object Notation Data Interchange Format

ReferenceTime

Details, die zur Ortszeit wirksam sind.

Name Typ Beschreibung
daylightSavings

string

Zeitersparnis in Minuten in der ReferenceUTCTimestamp.

posixTz

string

POSIX-Zeichenfolge zum Festlegen der Umgebungsvariablen für Zeitzonen.

posixTzValidYear

integer (int32)

Das Jahr, für das diese POSIX-Zeichenfolge gültig ist. Hinweis: Eine POSIX-Zeichenfolge ist nur im angegebenen Jahr gültig.

standardOffset

string

UTC-Offset im ReferenceUTCTimestamp.

sunrise

string (date-time)

Sunrise in der angegebenen Zeitzone, wie in der Tag Eigenschaft dargestellt, wird nur ausgefüllt, wenn der Anruf byCoordinatesist. Der Sonnenaufgang wird im ISO 8601 Format beschrieben. Beachten Sie, dass die Zeitzonen-API keine Sonnenaufgangs- und Sonnenuntergangszeiten zurückgibt, wenn der Sonnentag in der angeforderten Region beobachtet wird.

sunset

string (date-time)

Sonnenuntergang in der angegebenen Zeitzone, wie in der eigenschaft Tag dargestellt, wird nur ausgefüllt, wenn der Aufruf byCoordinatesist. Der Sonnenuntergang wird im ISO 8601 Format beschrieben. Beachten Sie, dass die Zeitzonen-API keine Sonnenaufgangs- und Sonnenuntergangszeiten zurückgibt, wenn der Sonnentag in der angeforderten Region beobachtet wird.

tag

string

Der Name der Zeitzone in Kraft beim Referenzzeitstempel (d. h. PST oder PDT, je nachdem, ob Die Sommerzeit in Kraft ist).

wallTime

string

Aktuelle Wandzeit in der angegebenen Zeitzone, wie in der eigenschaft Tag dargestellt.

RepresentativePoint

Repräsentative Point-Eigenschaft

Name Typ Beschreibung
latitude

number (float)

Latitude-Eigenschaft

longitude

number (float)

Longitude-Eigenschaft

TimeTransition

Stellt einen Zeitzonenwechsel dar.

Name Typ Beschreibung
daylightSavings

string

DaylightSavings-Eigenschaft

standardOffset

string

StandardOffset-Eigenschaft

tag

string

Tag-Eigenschaft

utcEnd

string (date-time)

Enddatum, Endzeit für diesen Übergangszeitraum

utcStart

string (date-time)

Startdatum, Startzeit für diesen Übergangszeitraum

TimezoneId

Zeitzonen-ID-Informationen.

Name Typ Beschreibung
aliases

string[]

Ein Array von Zeitzonen-ID-Aliasen. Wird nur zurückgegeben, wenn [options]=zoneinfo oder alle.

Hinweis: Möglicherweise ist null.

countries

CountryRecord[]

Ein Array von Länder-/Regionsdatensätzen. Wird nur zurückgegeben, wenn [options]=zoneinfo oder alle.

id

string

ID-Eigenschaft

names

TimezoneNames

Objekt für Zeitzonennamen.

referenceTime

ReferenceTime

Details, die zur Ortszeit wirksam sind.

representativePoint

RepresentativePoint

Repräsentative Point-Eigenschaft

timeTransitions

TimeTransition[]

Der DST der Zeitzone wechselt von [transitionsFrom] bis zum Zeitstempel + 1 Jahr.

TimezoneNames

Objekt für Zeitzonennamen.

Name Typ Beschreibung
daylight

string

Sommername

generic

string

Gattungsname

iso6391LanguageCode

string

Der ISO 639-1-Sprachcode der Namen

standard

string

Standardname

TimezoneOptions

Optionen für Zeitzoneninformationen wurden im Ergebnis angezeigt.

Wert Beschreibung
none

Fügen Sie keine Zoneinfo oder Übergänge in das Ergebnis ein.

zoneInfo

Fügen Sie zusätzliche Zeitzoneninformationen in das Ergebnis ein.

transitions

Übergangsinformationen in das Ergebnis einbeziehen (Die Anzahl der Übergänge ist derzeit auf 250 begrenzt).

all

Schließen Sie sowohl zoneinfo als auch transitions in das Ergebnis ein.

TimezoneResult

Dieses Objekt wird von einem erfolgreichen Timezone By ID-Aufruf oder von Koordinatenaufruf zurückgegeben.

Name Typ Beschreibung
referenceUtcTimestamp

string (date-time)

Referenz utc Timestamp-Eigenschaft

timeZones

TimezoneId[]

TimeZoneId-Array

version

string

Version-Eigenschaft