Timezone - Get Timezone By Coordinates
Use para obter as informações de fuso horário atuais, históricas e futuras para o par de latitude-longitude especificado.
A Get Timezone By Coordinates
API é uma solicitação HTTP GET
que retorna informações atuais, históricas e futuras de fuso horário para um par de latitude-longitude especificado. Além disso, a API fornece horários de pôr do sol e nascer do sol para um determinado local.
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 URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
format
|
path | True |
Formato desejado da resposta. Há suporte apenas para o formato |
|
api-version
|
query | True |
string |
Número de versão da API de Mapas Azure. |
query
|
query | True |
number[] |
Coordenadas do ponto para o qual as informações de fuso horário são solicitadas. Esse parâmetro é uma lista de coordenadas que contém um par de coordenadas (lat, long). Quando esse ponto de extremidade é chamado diretamente, as coordenadas são passadas como uma única cadeia de caracteres contendo coordenadas, separadas por vírgulas. |
options
|
query |
Como alternativa, use o alias "o". Opções disponíveis para tipos de informações retornadas no resultado. |
||
time
|
query |
string date-time |
Como alternativa, use o alias "stamp" ou "s". Hora de referência, se omitida, a API usará a hora do computador que atende à solicitação. |
|
transitions
|
query |
string date-time |
Como alternativa, use o alias "tf". A data de início da qual as transições de horário de verão (DST) são solicitadas só se aplica quando "opções" = todas ou "opções" = transições. |
|
transitions
|
query |
integer |
Como alternativa, use o alias "ty". O número de anos de "transitionsFrom" para o qual as transições DST são solicitadas só se aplica quando "opções" = todas ou "opções" = transições. |
Cabeçalho da solicitação
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
x-ms-client-id |
string |
Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes. |
|
Accept-Language |
string |
Especifica o código de idioma no qual os nomes de fuso horário devem ser retornados. Se nenhum código de idioma for fornecido, a resposta estará em "EN". Consulte Idiomas com suporte para obter detalhes. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Erro inesperado. |
Segurança
AADToken
Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso a Azure Mapas APIs REST. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.
Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.
Observações
- Essa definição de segurança requer o uso do
x-ms-client-id
cabeçalho para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.
O Authorization URL
é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de Microsoft Entra ID.
* O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
* O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
- Para obter mais informações sobre plataforma de identidade da Microsoft, consulte visão geral plataforma de identidade da Microsoft.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Essa é uma chave compartilhada provisionada quando você Create uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.
Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave master na conta em que elas são emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST para que sua chave possa ser armazenada com segurança.
Type:
apiKey
In:
query
SAS Token
Esse é um token de assinatura de acesso compartilhado criado com base na operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para a expiração, a taxa e as regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.
Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta de mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.
Type:
apiKey
In:
header
Exemplos
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"
}
]
}
]
}
Definições
Nome | Description |
---|---|
Country |
Um registro de país/região. |
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
Os detalhes do erro. |
Error |
Resposta de erro |
Json |
Formato desejado da resposta. Há suporte apenas para o formato |
Reference |
Detalhes em vigor na hora local. |
Representative |
Propriedade de ponto representativo |
Time |
|
Timezone |
|
Timezone |
Objeto de nomes de fuso horário. |
Timezone |
Como alternativa, use o alias "o". Opções disponíveis para tipos de informações retornadas no resultado. |
Timezone |
Esse objeto é retornado de uma chamada de timezone por ID bem-sucedida ou por chamada coordenadas |
CountryRecord
Um registro de país/região.
Nome | Tipo | Description |
---|---|---|
Code |
string |
Código de país/região iso-3166 de duas letras para o país/região. |
Name |
string |
Nome do país/região |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
Nome | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
Os detalhes do erro.
Nome | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
JsonFormat
Formato desejado da resposta. Há suporte apenas para o formato json
.
Nome | Tipo | Description |
---|---|---|
json |
string |
O formato de intercâmbio de dados de notação de objeto JavaScript |
ReferenceTime
Detalhes em vigor na hora local.
Nome | Tipo | Description |
---|---|---|
DaylightSavings |
string |
Tempo economizando em minutos em vigor no |
PosixTz |
string |
Cadeia de caracteres POSIX usada para definir a variável de ambiente de fuso horário. |
PosixTzValidYear |
integer |
O ano para o qual essa cadeia de caracteres POSIX é válida. Observação: uma cadeia de caracteres POSIX só será válida no ano especificado. |
StandardOffset |
string |
Deslocamento UTC em vigor no |
Sunrise |
string |
Nascer do sol no fuso horário especificado, conforme mostrado na |
Sunset |
string |
Pôr do sol no fuso horário especificado, conforme mostrado na |
Tag |
string |
Nome do fuso horário em vigor no carimbo de data/hora de referência (ou seja, PST ou PDT, dependendo se o Horário de Verão está em vigor). |
WallTime |
string |
Hora da parede atual no fuso horário especificado, conforme mostrado na |
RepresentativePoint
Propriedade de ponto representativo
Nome | Tipo | Description |
---|---|---|
Latitude |
number |
Propriedade Latitude |
Longitude |
number |
Propriedade Longitude |
TimeTransition
Nome | Tipo | Description |
---|---|---|
DaylightSavings |
string |
Propriedade DaylightSavings |
StandardOffset |
string |
Propriedade StandardOffset |
Tag |
string |
Propriedade Tag |
UtcEnd |
string |
Data de término, hora de término para esse período de transição |
UtcStart |
string |
Data de início, hora de início para este período de transição |
TimezoneId
Nome | Tipo | Description |
---|---|---|
Aliases |
string[] |
Uma matriz de aliases de ID de fuso horário. Retornado somente quando [options]=zoneinfo ou all. Observação: pode ser nulo. |
Countries |
Uma matriz de registros de país/região. Retornado somente quando [options]=zoneinfo ou all. |
|
Id |
string |
Propriedade Id |
Names |
Objeto de nomes de fuso horário. |
|
ReferenceTime |
Detalhes em vigor na hora local. |
|
RepresentativePoint |
Propriedade de ponto representativo |
|
TimeTransitions |
O DST de fuso horário faz a transição de [transitionsFrom] até o carimbo de data/hora + 1 ano. |
TimezoneNames
Objeto de nomes de fuso horário.
Nome | Tipo | Description |
---|---|---|
Daylight |
string |
Nome da Luz do Dia |
Generic |
string |
Nome genérico |
ISO6391LanguageCode |
string |
O código de idioma ISO 639-1 dos Nomes |
Standard |
string |
Nome padrão |
TimezoneOptions
Como alternativa, use o alias "o". Opções disponíveis para tipos de informações retornadas no resultado.
Nome | Tipo | Description |
---|---|---|
all |
string |
Inclua zoneinfo e transições no resultado. |
none |
string |
Não inclua zoneinfo ou transições no resultado. |
transitions |
string |
Inclua informações de transição no resultado (o número de transições atualmente está limitado a 250). |
zoneInfo |
string |
Inclua informações adicionais de fuso horário no resultado. |
TimezoneResult
Esse objeto é retornado de uma chamada de timezone por ID bem-sucedida ou por chamada coordenadas
Nome | Tipo | Description |
---|---|---|
ReferenceUtcTimestamp |
string |
Propriedade De carimbo de data/hora Utc de referência |
TimeZones |
Matriz TimeZoneId |
|
Version |
string |
Propriedade Version |