Timezone - Get Timezone By ID

Referencia

Servicio:: Maps

Versión de la API:: 1.0

Use para obtener la información de zona horaria actual, histórica y futura para el identificador de zona horaria de IANA especificado.

La API de Get Timezone By ID es una solicitud de GET HTTP que devuelve información de zona horaria actual, histórica y futura para el identificador de zona horaria de IANA especificado.

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

Con parámetros opcionales:

GET https://atlas.microsoft.com/timezone/byId/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	JsonFormat	Formato deseado de la respuesta. Solo se admite `json` formato.
api-version	query	True	string	Número de versión de la API de Azure Maps.
query	query	True	string	Identificador de zona horaria de IANA.
options	query		TimezoneOptions	Como alternativa, use el alias "o". Opciones disponibles para tipos de información devueltas en el resultado.
timeStamp	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.
transitionsFrom	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.
transitionsYears	query		integer	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	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 del identificador de Entra de Microsoft en Azure Maps, consulte los siguientes artículos de 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	TimezoneResult	De acuerdo
Other Status Codes	ErrorResponse	Error inesperado.

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0. Cuando se empareja con acceso basado en rol de Azure control, se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles 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 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.

Notas

Esta definición de seguridad requiere el uso del encabezado x-ms-client-id 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.

El 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 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	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: query

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 ID

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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"
        }
      ]
    }
  ]
}

Definiciones

Nombre	Description
CountryRecord	Un registro de país o región.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
JsonFormat	Formato deseado de la respuesta. Solo se admite `json` formato.
ReferenceTime	Detalles en vigor en la hora local.
RepresentativePoint	Propiedad de punto representativo
TimeTransition
TimezoneId
TimezoneNames	Objeto de nombres de zona horaria.
TimezoneOptions	Como alternativa, use el alias "o". Opciones disponibles para tipos de información devueltas en el resultado.
TimezoneResult	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	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

JsonFormat

Formato deseado de la respuesta. Solo se admite json formato.

Nombre	Tipo	Description
json	string	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 `ReferenceUTCTimestamp`.
PosixTz	string	Cadena POSIX utilizada para establecer la variable de entorno de zona horaria.
PosixTzValidYear	integer	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 `ReferenceUTCTimestamp`.
Sunrise	string	Sunrise at the given time zone as shown in the `Tag` property, populated only when the call is `byCoordinates`. El amanecer se describe en el formato iso 8601 . Tenga en cuenta que la API timezone no devuelve el amanecer y las horas de puesta de sol cuando se observa el día solar en la región solicitada.
Sunset	string	Sunset at the given time zone as shown in the `Tag` property, populated only when the call is `byCoordinates`. La puesta de sol se describe en el formato ISO 8601. Tenga en cuenta que la API timezone no devuelve el amanecer y las horas de puesta de sol cuando se observa el día solar en la región solicitada.
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 `Tag`.

RepresentativePoint

Propiedad de punto representativo

Nombre	Tipo	Description
Latitude	number	Latitude (propiedad)
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 todos los. Nota: puede ser null.
Countries	CountryRecord[]	Matriz de registros de país o región. Solo se devuelve cuando [options]=zoneinfo o todos los.
Id	string	Propiedad Id
Names	TimezoneNames	Objeto de nombres de zona horaria.
ReferenceTime	ReferenceTime	Detalles en vigor en la hora local.
RepresentativePoint	RepresentativePoint	Propiedad de punto representativo
TimeTransitions	TimeTransition[]	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

Como alternativa, use el alias "o". Opciones disponibles para 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á actualmente limitado a 250).
zoneInfo	string	Incluya información adicional de zona horaria 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	Reference Utc Timestamp (propiedad)
TimeZones	TimezoneId[]	Matriz TimeZoneId
Version	string	Propiedad Version

Compartir a través de