Timezone - Get Timezone By Coordinates

Use para obter as informações de fuso horário atual, histórico e futuro para o par de latitude-longitude especificado.
A API Get Timezone By Coordinates é 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, com exceção das regiões que observam os dias 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 URI

Nome Em Obrigatório Tipo Description
endpoint
path True

string

format
path True

JsonFormat

Formato desejado da resposta. Há suporte apenas para json formato.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

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, contendo 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

TimezoneOptions

Como alternativa, use o alias "o". Opções disponíveis para tipos de informações retornadas no resultado.

timeStamp
query

string (date-time)

Como alternativa, use o alias "stamp" ou "s". Hora de referência, se omitida, a API usará o tempo do computador que atende à solicitação.

transitionsFrom
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.

transitionsYears
query

integer (int32)

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

Indica a conta destinada a ser usada com o modelo de segurança do Microsoft Entra ID. Esse ID único para a conta Azure Mapas pode ser obtido a partir da API de Conta Azure Mapas plano de gerenciamento. Para mais informações sobre o uso da segurança Microsoft Entra ID em Azure Mapas, veja Gerencie autenticação em Azure Mapas.

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 de idiomas com suporte para obter detalhes.

Respostas

Nome Tipo Description
200 OK

TimezoneResult

A solicitação foi bem-sucedida.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

AadToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando combinado com o controle de acesso baseado em funções Azure , pode ser usado para controlar o acesso às APIs REST Azure Mapas. Controles de acesso baseados em função do Azure são usados para designar acesso a uma ou mais contas ou subrecursos de recursos do Azure Mapas. Qualquer usuário, grupo ou principal de serviço pode receber acesso via um papel embutido ou um papel personalizado composto por uma ou mais permissões para Azure Mapas APIs REST.\n\nPara implementar cenários, recomendamos visualizar conceitos autenticação. Em resumo, essa definição de segurança fornece uma solução para modelagem de aplicações(ões) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.\n\n#### Notas\n* Esta definição de segurança exige o uso do cabeçalho x-ms-client-id para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento Maps.\n* \nO Authorization URL é específico para a instância Azure nuvem pública. As nuvens soberanas possuem URLs de Autorização e configurações de Microsoft Entra ID únicas. \n* \nO controle de acesso baseado em função Azure é configurado a partir do plano de gerenciamento Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n* \nUso do Azure Mapas Web SDK permite a configuração de uma aplicação baseada em configuração para múltiplos casos de uso.\n* Para mais informações sobre plataforma de identidade da Microsoft, veja plataforma de identidade da Microsoft visão geral.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta Azure Mapas no portal Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.\n\n Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que são emitidas.\n\n Para aplicações publicamente expostas, nossa recomendação é usar a abordagem confidenciais de aplicativos clientes para acessar APIs REST Azure Mapas e assim sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: header

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação List SAS no recurso Azure Mapas através do plano de gerenciamento Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n\n Com este token, qualquer aplicativo está autorizado a acessar com Azure controles de acesso baseados em funções e controle detalhado da expiração, taxa e região(s) de uso do token específico. Em outras palavras, o Token SAS pode ser usado para permitir que aplicações controlem o acesso de forma mais segura do que a chave compartilhada.\n\n Para aplicações publicamente expostas, nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta Map para limitar abusos de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Successfully retrieve timezone by coordinates

Solicitação de exemplo

GET {endpoint}/timezone/byCoordinates/json?api-version=1.0&options=all&query=47,-122

Resposta de exemplo

{
  "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"
}

Definições

Nome Description
CountryRecord

Um registro de país/região.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).

JsonFormat

Formato desejado da resposta. Há suporte apenas para json formato.

ReferenceTime

Detalhes em vigor na hora local.

RepresentativePoint

Propriedade de ponto representativo

TimeTransition

Representa uma transição de fuso horário.

TimezoneId

Informações de identificação de fuso horário.

TimezoneNames

Objeto de nomes de fuso horário.

TimezoneOptions

As opções de informação sobre fuso horário retornavam no resultado.

TimezoneResult

Esse objeto é retornado de uma chamada de Timezone por ID bem-sucedida ou por chamada de Coordenadas

CountryRecord

Um registro de país/região.

Nome Tipo Description
code

string

Código de país/região de 2 letras ISO-3166 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

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

JsonFormat

Formato desejado da resposta. Há suporte apenas para json formato.

Valor Description
json

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

Economia de tempo em minutos em vigor no ReferenceUTCTimestamp.

posixTz

string

Cadeia de caracteres POSIX usada para definir a variável de ambiente de fuso horário.

posixTzValidYear

integer (int32)

O ano para o qual esta 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 ReferenceUTCTimestamp.

sunrise

string (date-time)

Nascer do sol no fuso horário determinado, conforme mostrado na propriedade Tag, populado somente quando a chamada é byCoordinates. O nascer do sol é descrito no formato iso 8601 . Observe que a API de Fuso Horário não retorna os horários de nascer e pôr do sol quando o dia solar é observado na região solicitada.

sunset

string (date-time)

Pôr do sol no fuso horário determinado, conforme mostrado na propriedade Tag, populado somente quando a chamada é byCoordinates. O pôr do sol é descrito no formato ISO 8601 . Observe que a API de Fuso Horário não retorna os horários de nascer e pôr do sol quando o dia solar é observado na região solicitada.

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

Tempo de parede atual no fuso horário especificado, conforme mostrado na propriedade Tag.

RepresentativePoint

Propriedade de ponto representativo

Nome Tipo Description
latitude

number (float)

Propriedade Latitude

longitude

number (float)

Propriedade Longitude

TimeTransition

Representa uma transição de fuso horário.

Nome Tipo Description
daylightSavings

string

Propriedade DaylightSavings

standardOffset

string

Propriedade StandardOffset

tag

string

Propriedade Etiqueta

utcEnd

string (date-time)

Data de término, hora de término para esse período de transição

utcStart

string (date-time)

Data de início, hora de início para este período de transição

TimezoneId

Informações de identificação de fuso horário.

Nome Tipo Description
aliases

string[]

Uma matriz de aliases de ID de fuso horário. Retornado somente quando [opções]=zoneinfo ou todos os.

Observação: pode ser nulo.

countries

CountryRecord[]

Uma matriz de registros de país/região. Retornado somente quando [opções]=zoneinfo ou todos os.

id

string

Propriedade Id

names

TimezoneNames

Objeto de nomes de fuso horário.

referenceTime

ReferenceTime

Detalhes em vigor na hora local.

representativePoint

RepresentativePoint

Propriedade de ponto representativo

timeTransitions

TimeTransition[]

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

As opções de informação sobre fuso horário retornavam no resultado.

Valor Description
none

Não inclua zoneinfo ou transições no resultado.

zoneInfo

Inclua informações adicionais de fuso horário no resultado.

transitions

Inclua informações de transição no resultado (o número de transições está atualmente limitado a 250).

all

Inclua zoneinfo e transitions no resultado.

TimezoneResult

Esse objeto é retornado de uma chamada de Timezone por ID bem-sucedida ou por chamada de Coordenadas

Nome Tipo Description
referenceUtcTimestamp

string (date-time)

Propriedade Reference Utc Timestamp

timeZones

TimezoneId[]

Matriz TimeZoneId

version

string

Propriedade Version