Time Zone API

Use the Time Zone API to list all available time zones and to get time zone information for a specified zone. Time zone information is stored in the registry of the Windows operating system.

Important

Microsoft periodically releases cumulative time zone updates. These updates include worldwide changes to time zone names, bias (the amount of time in minutes that a time zone is offset from Coordinated Universal Time (UTC)), and observance of daylight saving time. These patches update the information in the Windows registry. When these updates are available, apply them to all virtual machines in the deployment that are running a Microsoft Windows operating system.

Use this API with the Business Hours API to set the default time zone for a business hour.

This API is read-only.

URL

https://<server>/unifiedconfig/config/timezone/v2

Operations

  • list: Retrieves a list of available time zones. The list is sorted by UTC offset from the International Date Line from west to east.

  • get: Returns information for a specific time zone using the URL https://<server>/unifiedconfig/config/timezone/v2/<id>.

Response Parameters

  • name: The name of the time zone.

  • displayName: Specific bias and location information about the time zone, such as the offset from UTC and one or more places located within the time zone.

    Example: "(UTC-05:00) Eastern Time (US & Canada)"

  • changeStamp: See Shared Parameters.

Example Get Response

Code Snippet
Copy<timezone>
    <refURL>/unifiedconfig/config/timezone/v2/5000</refURL>
    <changeStamp>0</changeStamp>
    <displayName>(UTC-05:00) Eastern Time (US & Canada)</displayName>
    <name>UTC</name>
</timezone>