Timezone - Get Timezone By Coordinates

Ссылка

Служба:: Maps

Версия API:: 1.0

Используется для получения текущей, исторической и будущей информации часового пояса для указанной пары широты и долготы.

API Get Timezone By Coordinates — это http-запрос GET, который возвращает текущие, исторические и будущие сведения часового пояса для указанной пары широты и долготы. Кроме того, API предоставляет время заката и восхода для заданного расположения, за исключением регионов, которые наблюдают солнечные дни.

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}

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	JsonFormat	Требуемый формат ответа. Поддерживается только `json` формат.
api-version	query	True	string	Номер версии API Azure Maps.
query	query	True	number[]	Координаты точки, для которой запрашивается информация о часовом поясе. Этот параметр представляет собой список координат, содержащий пару координат (lat, long). При вызове этой конечной точки координаты передаются в виде одной строки, содержащей координаты, разделенные запятыми.
options	query		TimezoneOptions	Кроме того, используйте псевдоним "o". Параметры, доступные для типов сведений, возвращаемых в результате.
timeStamp	query		string date-time	Кроме того, используйте псевдоним "stamp" или "s". Время ссылки, если опущено, API будет использовать время компьютера, обслуживая запрос.
transitionsFrom	query		string date-time	Кроме того, используйте псевдоним "tf". Дата начала, из которой запрашиваются переходы с летнего времени (DST), применяется только при переходе "options" = all или "options".
transitionsYears	query		integer	Кроме того, используйте псевдоним "ty". Число лет от "transitionsFrom", для которого запрашиваются переходы DST, применяется только в том случае, если "параметры" = все или "параметры" = переходы.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности идентификатора Microsoft Entra. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Сведения о том, как использовать безопасность идентификатора Microsoft Entra в Azure Maps, см. в следующих статьях .
Accept-Language		string	Указывает языковой код, в котором должны быть возвращены имена часовых поясов. Если код языка не указан, ответ будет находиться в "EN". Дополнительные сведения см. в поддерживаемых языках.

Ответы

Имя	Тип	Описание
200 OK	TimezoneResult	ХОРОШО
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

Безопасность

AADToken

Это потоки Microsoft Entra OAuth 2.0. При паре с доступом на основе ролей Azure его можно использовать для управления доступом к REST API Azure Maps. Управление доступом на основе ролей Azure используется для назначения доступа к одной или нескольким учетным записям ресурсов Azure Maps или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.

Для реализации сценариев рекомендуется просматривать концепции проверки подлинности . В целом, это определение безопасности предоставляет решение для моделирования приложений через объекты, способные управлять доступом в определенных API и областях.

Примечания

Для этого определения безопасности требуется использовать заголовок x-ms-client-id, чтобы указать, к какой ресурсу Azure Maps приложение запрашивает доступ. Это можно получить изAPI управления картами .

Authorization URL зависит от экземпляра общедоступного облака Azure. В национальных облаках есть уникальные URL-адреса авторизации и конфигурации идентификатора Microsoft Entra. * Управление доступом на основе ролей Azure настраивается с плоскости управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API. * Использование веб-пакета SDK Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.

Дополнительные сведения о платформе удостоверений Майкрософт см. в обзоре платформы удостоверений Майкрософт.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, подготовленный при создания учетной записи Azure Maps на портале Azure или с помощью PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого ключа любой приложение может получить доступ ко всем REST API. Другими словами, этот ключ можно использовать в качестве главного ключа в учетной записи, в которую они выданы.

Для общедоступных приложений мы рекомендуем использовать конфиденциальные клиентские приложения, подход для доступа к REST API Azure Maps, чтобы ваш ключ можно было безопасно хранить.

Тип: apiKey
В: query

SAS Token

Это маркер подписанного URL-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого маркера любой приложению разрешен доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Другими словами, маркер SAS можно использовать для разрешения приложений управлять доступом более защищенным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты карты, чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Тип: apiKey
В: header

Примеры

Successfully retrieve timezone by coordinates

Образец запроса

HTTP

GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&options=all&query=47,-122

Пример ответа

Код состояния:: 200

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

Определения

Имя	Описание
CountryRecord	Запись страны или региона.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
JsonFormat	Требуемый формат ответа. Поддерживается только `json` формат.
ReferenceTime	Сведения о действии в локальное время.
RepresentativePoint	Свойство Репрезентативной точки
TimeTransition
TimezoneId
TimezoneNames	Объект имен часового пояса.
TimezoneOptions	Кроме того, используйте псевдоним "o". Параметры, доступные для типов сведений, возвращаемых в результате.
TimezoneResult	Этот объект возвращается из успешного вызова Часового пояса по идентификатору или по координатам

CountryRecord

Запись страны или региона.

Имя	Тип	Описание
Code	string	Iso-3166 2-буквенный код страны или региона для страны или региона.
Name	string	имя страны или региона

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

JsonFormat

Требуемый формат ответа. Поддерживается только json формат.

Имя	Тип	Описание
json	string	формат обмена данными для объектов JavaScript

ReferenceTime

Сведения о действии в локальное время.

Имя	Тип	Описание
DaylightSavings	string	Экономия времени в минутах в `ReferenceUTCTimestamp`.
PosixTz	string	Строка POSIX, используемая для задания переменной среды часового пояса.
PosixTzValidYear	integer	Год этой строки POSIX действителен. Примечание. Строка POSIX будет действительна только в течение заданного года.
StandardOffset	string	Смещение в формате UTC в `ReferenceUTCTimestamp`.
Sunrise	string	Восход в заданном часовом поясе, как показано в свойстве `Tag`, заполняется только в том случае, если вызов `byCoordinates`. Восход солнца описан в формате ISO 8601. Обратите внимание, что API часового пояса не возвращает время восхода и заката, когда солнечный день наблюдается в запрошенном регионе.
Sunset	string	Закат в заданном часовом поясе, как показано в свойстве `Tag`, заполняется только в том случае, если вызов `byCoordinates`. Закат описан в формате ISO 8601. Обратите внимание, что API часового пояса не возвращает время восхода и заката, когда солнечный день наблюдается в запрошенном регионе.
Tag	string	Имя часового пояса в действии в метке времени ссылки (т. е. PST или PDT в зависимости от того, действует ли время летнего времени).
WallTime	string	Текущее время стены в заданном часовом поясе, как показано в свойстве `Tag`.

RepresentativePoint

Свойство Репрезентативной точки

Имя	Тип	Описание
Latitude	number	Свойство Latitude
Longitude	number	Свойство Долготы

TimeTransition

Имя	Тип	Описание
DaylightSavings	string	Свойство DaylightSavings
StandardOffset	string	Свойство StandardOffset
Tag	string	Свойство Tag
UtcEnd	string	Дата окончания, время окончания этого переходного периода
UtcStart	string	Дата начала, время начала этого переходного периода

TimezoneId

Имя	Тип	Описание
Aliases	string[]	Массив псевдонимов идентификаторов часового пояса. Возвращается только в том случае, если [параметры]=zoneinfo или всех. Примечание. Может иметь значение NULL.
Countries	CountryRecord[]	Массив записей страны или региона. Возвращается только в том случае, если [параметры]=zoneinfo или всех.
Id	string	Свойство Id
Names	TimezoneNames	Объект имен часового пояса.
ReferenceTime	ReferenceTime	Сведения о действии в локальное время.
RepresentativePoint	RepresentativePoint	Свойство Репрезентативной точки
TimeTransitions	TimeTransition[]	Часовой пояс DST переходит от [transitionsFrom] до метки времени + 1 год.

TimezoneNames

Объект имен часового пояса.

Имя	Тип	Описание
Daylight	string	Имя дневного света
Generic	string	Универсальное имя
ISO6391LanguageCode	string	Код языка ISO 639-1 имен
Standard	string	Стандартное имя

TimezoneOptions

Кроме того, используйте псевдоним "o". Параметры, доступные для типов сведений, возвращаемых в результате.

Имя	Тип	Описание
all	string	Включите как zoneinfo, так и переходы в результат.
none	string	Не включать zoneinfo или переходы в результат.
transitions	string	Включите сведения о переходе в результат (число переходов в настоящее время ограничено 250).
zoneInfo	string	Добавьте дополнительные сведения о часовом поясе в результат.

TimezoneResult

Этот объект возвращается из успешного вызова Часового пояса по идентификатору или по координатам

Имя	Тип	Описание
ReferenceUtcTimestamp	string	Свойство Reference UTC Timestamp
TimeZones	TimezoneId[]	Массив TimeZoneId
Version	string	Свойство Version

Поделиться через