Timezone - Get Timezone By Coordinates
Utilícelo para obtener la información de zona horaria actual, histórica y futura para el par latitud-longitud especificado.
La API de Get Timezone By Coordinates es una solicitud de GET HTTP que devuelve información de zona horaria actual, histórica y futura para un par de latitud-longitud especificado. Además, la API proporciona horas de puesta de sol y de amanecer para una ubicación determinada, con la excepción de las regiones que observan días solares.
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}
Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
El nombre de host del servicio Azure Maps. Usa |
|
format
|
path | True |
Formato deseado de la respuesta. Solo se admite |
|
|
api-version
|
query | True |
string minLength: 1 |
Versión de API que se usará para esta operación. |
|
query
|
query | True |
number[] |
Coordenadas del punto para el que se solicita información de zona horaria. Este parámetro es una lista de coordenadas, que contiene un par de coordenadas (lat, long). Cuando se llama directamente a este punto de conexión, las coordenadas se pasan como una sola cadena que contiene coordenadas, separadas por comas. |
|
options
|
query |
Como alternativa, use el alias "o". Opciones disponibles para tipos de información devueltas en el resultado. |
||
|
time
|
query |
string (date-time) |
Como alternativa, use alias "stamp" o "s". Hora de referencia, si se omite, la API usará el tiempo de la máquina que atiende la solicitud. |
|
|
transitions
|
query |
string (date-time) |
Como alternativa, use el alias "tf". La fecha de inicio a partir de la cual se solicitan transiciones de horario de verano (DST), solo se aplica cuando "options" = all o "options" = transitions. |
|
|
transitions
|
query |
integer (int32) |
Como alternativa, use el alias "ty". El número de años de "transitionsFrom" para los que se solicitan las transiciones de DST, solo se aplica cuando "options" = all o "options" = transitions. |
Encabezado de la solicitud
| Nombre | Requerido | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Indica la cuenta destinada a usarse con el modelo de seguridad Microsoft Entra ID. Este ID único para la cuenta de Azure Maps puede obtenerse desde la API de la cuenta Azure Maps plano de gestión. Para más información sobre el uso de la seguridad Microsoft Entra ID en Azure Maps, consulte Gestionar la autenticación en Azure Maps. |
|
| Accept-Language |
string |
Especifica el código de idioma en el que se deben devolver los nombres de zona horaria. Si no se proporciona ningún código de idioma, la respuesta estará en "EN". Consulte idiomas admitidos para obtener más información. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
La solicitud se ha realizado correctamente. |
|
| Other Status Codes |
Una respuesta de error inesperada. |
Seguridad
AadToken
Estos son los flujos Microsoft Entra OAuth 2.0. Cuando se combina con el control de acceso basado en roles Azure puede usarse para controlar el acceso a Azure Maps APIs REST. Los controles de acceso basados en roles de Azure se utilizan para designar el acceso a una o más cuentas o subrecursos de recursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.
Para implementar escenarios, se recomienda ver conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.
Note
- Esta definición de seguridad requiere el uso del encabezado
x-ms-client-idpara indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps. - El
Authorization URLes específico de la instancia de nube pública de Azure. Las nubes soberanas tienen URLs de Autorización y configuraciones de Microsoft Entra ID únicas. - El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
- El uso de SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
- Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
| Nombre | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Se trata de una clave compartida que se aprovisiona al Creación de una cuenta de Azure Maps en Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.
Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.
Para las aplicaciones expuestas públicamente, nuestra recomendación es usar las aplicaciones cliente confidenciales enfoque acceder a las API REST de Azure Maps para que la clave se pueda almacenar de forma segura.
Tipo:
apiKey
En:
header
SAS Token
Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle el acceso de forma más segura que la clave compartida.
En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.
Tipo:
apiKey
En:
header
Ejemplos
Successfully retrieve timezone by coordinates
Solicitud de ejemplo
GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&options=all&query=47,-122
Respuesta de muestra
{
"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"
}
Definiciones
| Nombre | Description |
|---|---|
|
Country |
Un registro de país o región. |
|
Error |
Información adicional sobre el error de administración de recursos. |
|
Error |
Detalle del error. |
|
Error |
Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData). |
|
Json |
Formato deseado de la respuesta. Solo se admite |
|
Reference |
Detalles en vigor en la hora local. |
|
Representative |
Propiedad de punto representativo |
|
Time |
Representa una transición de huso horario. |
|
Timezone |
Información de identificación horaria. |
|
Timezone |
Objeto de nombres de zona horaria. |
|
Timezone |
Las opciones para la información de la zona horaria devolvieron en el resultado. |
|
Timezone |
Este objeto se devuelve de una llamada correcta a Timezone By ID o a By Coordinates. |
CountryRecord
Un registro de país o región.
| Nombre | Tipo | Description |
|---|---|---|
| code |
string |
Código de país o región iso-3166 de 2 letras para el país o región. |
| name |
string |
nombre de país o región |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
| Nombre | Tipo | Description |
|---|---|---|
| info |
object |
Información adicional. |
| type |
string |
Tipo de información adicional. |
ErrorDetail
Detalle del error.
| Nombre | Tipo | Description |
|---|---|---|
| additionalInfo |
Información adicional del error. |
|
| code |
string |
Código de error. |
| details |
Detalles del error. |
|
| message |
string |
El mensaje de error. |
| target |
string |
Destino del error. |
ErrorResponse
Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData).
| Nombre | Tipo | Description |
|---|---|---|
| error |
Objeto de error. |
JsonFormat
Formato deseado de la respuesta. Solo se admite json formato.
| Valor | Description |
|---|---|
| json |
el formato de intercambio de datos de notación de objetos JavaScript |
ReferenceTime
Detalles en vigor en la hora local.
| Nombre | Tipo | Description |
|---|---|---|
| daylightSavings |
string |
Ahorro de tiempo en minutos en vigor en el |
| posixTz |
string |
Cadena POSIX utilizada para establecer la variable de entorno de zona horaria. |
| posixTzValidYear |
integer (int32) |
El año en que esta cadena POSIX es válida. Nota: Una cadena POSIX solo será válida en el año dado. |
| standardOffset |
string |
Desplazamiento UTC en vigor en el |
| sunrise |
string (date-time) |
Amanecer en la zona horaria especificada como se muestra en la |
| sunset |
string (date-time) |
Puesta de sol en la zona horaria especificada como se muestra en la |
| tag |
string |
Nombre de zona horaria en vigor en la marca de tiempo de referencia (es decir, PST o PDT en función de si el horario de verano está en vigor). |
| wallTime |
string |
Tiempo de pared actual en la zona horaria especificada, tal como se muestra en la propiedad |
RepresentativePoint
Propiedad de punto representativo
| Nombre | Tipo | Description |
|---|---|---|
| latitude |
number (float) |
Latitude (propiedad) |
| longitude |
number (float) |
Longitud (propiedad) |
TimeTransition
Representa una transición de huso horario.
| Nombre | Tipo | Description |
|---|---|---|
| daylightSavings |
string |
Propiedad DaylightSavings |
| standardOffset |
string |
StandardOffset , propiedad |
| tag |
string |
Tag (propiedad) |
| utcEnd |
string (date-time) |
Fecha de finalización, hora de finalización para este período de transición |
| utcStart |
string (date-time) |
Fecha de inicio, hora de inicio para este período de transición |
TimezoneId
Información de identificación horaria.
| Nombre | Tipo | Description |
|---|---|---|
| aliases |
string[] |
Matriz de alias de identificador de zona horaria. Solo se devuelve cuando [options]=zoneinfo o todos los. Nota: puede ser null. |
| countries |
Matriz de registros de país o región. Solo se devuelve cuando [options]=zoneinfo o todos los. |
|
| id |
string |
Propiedad Id |
| names |
Objeto de nombres de zona horaria. |
|
| referenceTime |
Detalles en vigor en la hora local. |
|
| representativePoint |
Propiedad de punto representativo |
|
| timeTransitions |
El DST de zona horaria realiza transiciones de [transitionsFrom] hasta la marca de tiempo + 1 año. |
TimezoneNames
Objeto de nombres de zona horaria.
| Nombre | Tipo | Description |
|---|---|---|
| daylight |
string |
Nombre de verano |
| generic |
string |
Nombre genérico |
| iso6391LanguageCode |
string |
El código de idioma ISO 639-1 de los nombres |
| standard |
string |
Nombre estándar |
TimezoneOptions
Las opciones para la información de la zona horaria devolvieron en el resultado.
| Valor | Description |
|---|---|
| none |
No incluya zoneinfo ni transitions en el resultado. |
| zoneInfo |
Incluya información adicional sobre la zona horaria en el resultado. |
| transitions |
Incluya información de transición en el resultado (el número de transiciones está actualmente limitado a 250). |
| all |
Incluya zoneinfo y transitions en el resultado. |
TimezoneResult
Este objeto se devuelve de una llamada correcta a Timezone By ID o a By Coordinates.
| Nombre | Tipo | Description |
|---|---|---|
| referenceUtcTimestamp |
string (date-time) |
Reference Utc Timestamp (propiedad) |
| timeZones |
Matriz TimeZoneId |
|
| version |
string |
Version (propiedad) |