Timezone - Get Timezone By Coordinates

Référence

Service:: Maps

Version d'API:: 1.0

Permet d’obtenir les informations actuelles, historiques et futures du fuseau horaire pour la paire latitude-longitude spécifiée.

L’API Get Timezone By Coordinates est une requête HTTP GET qui retourne les informations actuelles, historiques et futures du fuseau horaire pour une paire latitude-longitude spécifiée. En outre, l’API fournit des heures de coucher et de lever du soleil pour un emplacement donné.

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

Avec des paramètres facultatifs:

GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&options={options}&timeStamp={timeStamp}&transitionsFrom={transitionsFrom}&transitionsYears={transitionsYears}&query={query}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
format	path	True	JsonFormat	Format souhaité de la réponse. Seul le format `json` est pris en charge.
api-version	query	True	string	Numéro de version de l’API Azure Maps.
query	query	True	number[]	Coordonnées du point pour lequel les informations de fuseau horaire sont demandées. Ce paramètre est une liste de coordonnées, contenant une paire de coordonnées(lat, long). Lorsque ce point de terminaison est appelé directement, les coordonnées sont transmises sous la forme d’une chaîne unique contenant des coordonnées, séparées par des virgules.
options	query		TimezoneOptions	Vous pouvez également utiliser l’alias « o ». Options disponibles pour les types d’informations retournées dans le résultat.
timeStamp	query		string date-time	Vous pouvez également utiliser l’alias « stamp » ou « s ». Heure de référence, si elle est omise, l’API utilise le temps de l’ordinateur pour traiter la requête.
transitionsFrom	query		string date-time	Vous pouvez également utiliser l’alias « tf ». La date de début à partir de laquelle les transitions d’heure d’été (DST) sont demandées, s’applique uniquement lorsque « options » = all ou « options » = transitions.
transitionsYears	query		integer	Vous pouvez également utiliser l’alias « ty ». Nombre d’années entre « transitionsFrom » pour lesquelles des transitions DST sont demandées, s’applique uniquement lorsque « options » = all ou « options » = transitions.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Spécifie quel compte est destiné à être utilisé conjointement avec le modèle de sécurité de l’ID Microsoft Entra. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API Compte du plan de gestion Azure Maps. Pour utiliser la sécurité des ID Microsoft Entra dans Azure Maps, consultez les articles suivants pour obtenir des conseils.
Accept-Language		string	Spécifie le code de langue dans lequel les noms de fuseau horaire doivent être retournés. Si aucun code de langue n’est fourni, la réponse se trouve dans « EN ». Pour plus d’informations, consultez Langues prises en charge .

Réponses

Nom	Type	Description
200 OK	TimezoneResult	Ok
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux OAuth Microsoft Entra 2.0 . Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure , il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Ou sous-ressources Azure Maps. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations aux API REST Azure Maps.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps.

Authorization URL est spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST. * L’utilisation du KIT de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

Pour plus d’informations sur la plateforme d’identités Microsoft, consultez Vue d’ensemble de la plateforme d’identités Microsoft.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Il s’agit d’une clé partagée qui est provisionnée lorsque vous créez un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, de l’interface CLI, des SDK Azure ou de l’API REST.

Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé principale dans le compte dans lequel elle est émise.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’approche des applications clientes confidentielles pour accéder aux API REST Azure Maps afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: query

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle de grain précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, notre recommandation est de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

Successfully retrieve timezone by coordinates

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "Version": "2019a",
  "ReferenceUtcTimestamp": "2019-06-17T22:16:59.0765556Z",
  "TimeZones": [
    {
      "Id": "America/Los_Angeles",
      "Aliases": [
        "US/Pacific",
        "US/Pacific-New"
      ],
      "Countries": [
        {
          "Name": "United States",
          "Code": "US"
        }
      ],
      "Names": {
        "ISO6391LanguageCode": "en",
        "Generic": "Pacific Time",
        "Standard": "Pacific Standard Time",
        "Daylight": "Pacific Daylight Time"
      },
      "ReferenceTime": {
        "Tag": "PDT",
        "StandardOffset": "-08:00:00",
        "DaylightSavings": "01:00:00",
        "WallTime": "2019-06-17T15:16:59.0765556-07:00",
        "PosixTzValidYear": 2019,
        "PosixTz": "PST+8PDT,M3.2.0,M11.1.0",
        "Sunrise": "2019-06-17T05:12:21.267-07:00",
        "Sunset": "2019-06-17T21:05:18.017-07:00"
      },
      "RepresentativePoint": {
        "Latitude": 34.05222222222222,
        "Longitude": -118.24277777777777
      },
      "TimeTransitions": [
        {
          "Tag": "PDT",
          "StandardOffset": "-08:00:00",
          "DaylightSavings": "01:00:00",
          "UtcStart": "2019-03-10T10:00:00Z",
          "UtcEnd": "2019-11-03T09:00:00Z"
        },
        {
          "Tag": "PST",
          "StandardOffset": "-08:00:00",
          "DaylightSavings": "00:00:00",
          "UtcStart": "2019-11-03T09:00:00Z",
          "UtcEnd": "2020-03-08T10:00:00Z"
        },
        {
          "Tag": "PDT",
          "StandardOffset": "-08:00:00",
          "DaylightSavings": "01:00:00",
          "UtcStart": "2020-03-08T10:00:00Z",
          "UtcEnd": "2020-11-01T09:00:00Z"
        }
      ]
    }
  ]
}

Définitions

Nom	Description
CountryRecord	Enregistrement de pays/région.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
JsonFormat	Format souhaité de la réponse. Seul le format `json` est pris en charge.
ReferenceTime	Détails en vigueur à l’heure locale.
RepresentativePoint	Propriété point représentatif
TimeTransition
TimezoneId
TimezoneNames	Objet De noms de fuseau horaire.
TimezoneOptions	Vous pouvez également utiliser l’alias « o ». Options disponibles pour les types d’informations retournées dans le résultat.
TimezoneResult	Cet objet est retourné à partir d’un appel de fuseau horaire par ID ou par coordonnées réussi

CountryRecord

Enregistrement de pays/région.

Nom	Type	Description
Code	string	Code pays/région iso-3166 à 2 lettres pour le pays/la région.
Name	string	nom du pays/de la région

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

JsonFormat

Format souhaité de la réponse. Seul le format json est pris en charge.

Nom	Type	Description
json	string	Format d’échange de données de notation d’objet JavaScript

ReferenceTime

Détails en vigueur à l’heure locale.

Nom	Type	Description
DaylightSavings	string	Gain de temps en minutes en vigueur au .`ReferenceUTCTimestamp`
PosixTz	string	Chaîne POSIX utilisée pour définir la variable d’environnement de fuseau horaire.
PosixTzValidYear	integer	Année pour laquelle cette chaîne POSIX est valide. Remarque : Une chaîne POSIX sera valide uniquement dans l’année donnée.
StandardOffset	string	Décalage UTC en vigueur au .`ReferenceUTCTimestamp`
Sunrise	string	Lever de soleil au fuseau horaire donné, comme indiqué dans la `Tag` propriété . Le lever du soleil est décrit dans le format ISO8601. (être renseigné uniquement si l’appel est byCoordinates)
Sunset	string	Coucher de soleil au fuseau horaire donné, comme indiqué dans la `Tag` propriété . Le coucher du soleil est décrit dans le format ISO8601. (être renseigné uniquement si l’appel est byCoordinates)
Tag	string	Nom du fuseau horaire en vigueur dans l’horodatage de référence (par exemple, PST ou PDT selon que l’heure d’été est en vigueur).
WallTime	string	Heure de mur actuelle au fuseau horaire donné, comme indiqué dans la `Tag` propriété .

RepresentativePoint

Propriété point représentatif

Nom	Type	Description
Latitude	number	Propriété Latitude
Longitude	number	Longitude, propriété

TimeTransition

Nom	Type	Description
DaylightSavings	string	Propriété DaylightSavings
StandardOffset	string	Propriété StandardOffset
Tag	string	Tag (propriété)
UtcEnd	string	Date de fin, heure de fin de cette période de transition
UtcStart	string	Date de début, heure de début de cette période de transition

TimezoneId

Nom	Type	Description
Aliases	string[]	Tableau d’alias d’ID de fuseau horaire. Retourné uniquement lorsque [options]=zoneinfo ou tout. Remarque : peut être null.
Countries	CountryRecord[]	Tableau d’enregistrements pays/régions. Retourné uniquement lorsque [options]=zoneinfo ou tout.
Id	string	Id, propriété
Names	TimezoneNames	Objet De noms de fuseau horaire.
ReferenceTime	ReferenceTime	Détails en vigueur à l’heure locale.
RepresentativePoint	RepresentativePoint	Propriété point représentatif
TimeTransitions	TimeTransition[]	Fuseau horaire DST passe de [transitionsFrom] à timestamp + 1 an.

TimezoneNames

Objet De noms de fuseau horaire.

Nom	Type	Description
Daylight	string	Nom de la lumière du jour
Generic	string	Generic Name
ISO6391LanguageCode	string	Code de langage ISO 639-1 des noms
Standard	string	Nom standard

TimezoneOptions

Vous pouvez également utiliser l’alias « o ». Options disponibles pour les types d’informations retournées dans le résultat.

Nom	Type	Description
all	string	Incluez les informations de zone et les transitions dans le résultat.
none	string	N’incluez pas zoneinfo ou transitions dans le résultat.
transitions	string	Incluez les informations de transition dans le résultat (le nombre de transitions est actuellement limité à 250).
zoneInfo	string	Incluez des informations de fuseau horaire supplémentaires dans le résultat.

TimezoneResult

Cet objet est retourné à partir d’un appel de fuseau horaire par ID ou par coordonnées réussi

Nom	Type	Description
ReferenceUtcTimestamp	string	Référence Utc Timestamp, propriété
TimeZones	TimezoneId[]	Tableau TimeZoneId
Version	string	Propriété Version

Partager via