Timezone - Get Timezone By Coordinates
Use para obtener la información de zona horaria actual, histórica y futura para el par de latitud y longitud especificados.
La Get Timezone By Coordinates
API es una solicitud HTTP GET
que devuelve información de zona horaria actual, histórica y futura para un par de latitud y longitud especificados. Además, la API proporciona horas de puesta de sol y de amanecer para una ubicación determinada.
GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&query={query}
GET https://atlas.microsoft.com/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 |
---|---|---|---|---|
format
|
path | True |
Formato deseado de la respuesta. Solo se admite el formato |
|
api-version
|
query | True |
string |
Número de versión de la API de Azure Maps. |
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 los tipos de información devueltas en el resultado. |
||
time
|
query |
string date-time |
Como alternativa, use el 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 desde la que se solicitan transiciones de horario de verano (DST), solo se aplica cuando "options" = all o "options" = transitions. |
|
transitions
|
query |
integer |
Como alternativa, use el alias "ty". El número de años a partir de "transitionsFrom" para los que se solicitan 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 |
Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de id. de Microsoft Entra. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad de id. de Microsoft Entra en Azure Maps, consulte los siguientes artículos para obtener instrucciones. |
|
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 |
Aceptar |
|
Other Status Codes |
Se ha producido un error inesperado. |
Seguridad
AADToken
Estos son los flujos de Microsoft Entra OAuth 2.0 . Cuando se empareja con el control de acceso basado en rol de Azure , se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en rol de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio mediante un rol integrado o un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.
Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.
Notas
- Esta definición de seguridad requiere el uso del
x-ms-client-id
encabezado para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.
Authorization URL
es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra.
* El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
* El uso del 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
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Se trata de una clave compartida que se aprovisiona al crear 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.
En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a las API REST de Azure Maps para que la clave se pueda almacenar de forma segura.
Tipo:
apiKey
En:
query
SAS Token
Se trata de un token de firma de acceso compartido que se crea 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, la CLI, los SDK de Azure o las API REST.
Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de 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 controlen 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 la cuenta de mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.
Tipo:
apiKey
En:
header
Ejemplos
Successfully retrieve timezone by coordinates
Sample request
GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&options=all&query=47,-122
Sample response
{
"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"
}
]
}
]
}
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 de error |
Json |
Formato deseado de la respuesta. Solo se admite el formato |
Reference |
Detalles en vigor en la hora local. |
Representative |
Propiedad de punto representativo |
Time |
|
Timezone |
|
Timezone |
Objeto de nombres de zona horaria. |
Timezone |
Como alternativa, use el alias "o". Opciones disponibles para los tipos de información devueltas en el resultado. |
Timezone |
Este objeto se devuelve de una llamada a Timezone By ID correcta o por coordenadas. |
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 |
Los detalles del error. |
|
message |
string |
El mensaje de error. |
target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
JsonFormat
Formato deseado de la respuesta. Solo se admite el formato json
.
Nombre | Tipo | Description |
---|---|---|
json |
string |
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 . |
PosixTz |
string |
Cadena POSIX usada para establecer la variable de entorno de zona horaria. |
PosixTzValidYear |
integer |
El año en el que esta cadena POSIX es válida. Nota: Una cadena POSIX solo será válida en el año especificado. |
StandardOffset |
string |
Desplazamiento UTC en vigor en . |
Sunrise |
string |
Amanecer en la zona horaria especificada como se muestra en la |
Sunset |
string |
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 |
RepresentativePoint
Propiedad de punto representativo
Nombre | Tipo | Description |
---|---|---|
Latitude |
number |
Propiedad Latitude |
Longitude |
number |
Longitud (propiedad) |
TimeTransition
Nombre | Tipo | Description |
---|---|---|
DaylightSavings |
string |
Propiedad DaylightSavings |
StandardOffset |
string |
StandardOffset (propiedad) |
Tag |
string |
Tag (propiedad) |
UtcEnd |
string |
Fecha de finalización, hora de finalización para este período de transición |
UtcStart |
string |
Fecha de inicio, hora de inicio para este período de transición |
TimezoneId
Nombre | Tipo | Description |
---|---|---|
Aliases |
string[] |
Matriz de alias de identificador de zona horaria. Solo se devuelve cuando [options]=zoneinfo o all. Nota: puede ser null. |
Countries |
Matriz de registros de país o región. Solo se devuelve cuando [options]=zoneinfo o all. |
|
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 |
La DST de zona horaria pasa 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
Como alternativa, use el alias "o". Opciones disponibles para los tipos de información devueltas en el resultado.
Nombre | Tipo | Description |
---|---|---|
all |
string |
Incluya zoneinfo y transiciones en el resultado. |
none |
string |
No incluya zoneinfo ni transiciones en el resultado. |
transitions |
string |
Incluir información de transición en el resultado (el número de transiciones está limitado actualmente a 250). |
zoneInfo |
string |
Incluya información adicional de zona horaria en el resultado. |
TimezoneResult
Este objeto se devuelve de una llamada a Timezone By ID correcta o por coordenadas.
Nombre | Tipo | Description |
---|---|---|
ReferenceUtcTimestamp |
string |
Referencia de la propiedad Timestamp Utc |
TimeZones |
Matriz TimeZoneId |
|
Version |
string |
Version, propiedad |