Time Zone Data
The Bing Maps Time Zone API returns responses in either XML or JSON. All responses include at least one TimeZone
resource. Optionally, either a convertedTime
resource or a DstRule
resource, or both, will be included in each response.
These resources are described below.
TimeZone Resource
Field Description | JSON Fields |
XML Fields |
---|---|---|
Standard name of the time zone, e.g. Pacific standard time |
genericName |
GenericName |
Abbreviation for the time zone, e.g. PST |
abbreviation |
Abbreviation |
Time zone name per the IANA standard1 | ianaTimeZoneId |
IANATimeZoneID |
Time zone name as per the Microsoft Windows standard | windowsTimeZoneID |
WindowsTimeZoneID |
Offset of time zone from UTC, in (+/-)hh:mm format |
utcOffset |
UTCOffset |
ConvertedTime Resource |
convertedTime |
ConvertedTime |
DstRule Resource2 |
dstRule |
DSTRule |
1 If either desttz
is set to a valid Windows Time Zone ID or standardtimezoneid
is WINDOWS
, then the IANA Time Zone ID field will not be present in the response.
2 Present in the response only if both includeDstRules
is true
and Dst Rules are available for the requested IANA or Windows Time Zone ID.
ConvertedTime Resource
Field Description | JSON Fields |
XML Fields |
---|---|---|
Local time for designated time zone, in UTC format | localTime |
LocalTime |
UTC offset with DST, (+/-)hh:mm format |
utcOffsetWithDst |
UTCOffsetWithDst |
Display name of time zone, e.g. Pacific Daylight Time |
timeZoneDisplayName |
TimeZoneDisplayName |
Display Time zone abbreviation, e.g. PDT |
timeZoneDisplayAbbr |
TimeZoneDisplayAbbr |
DstRule Resource
Field Description | JSON Fields |
XML Fields |
---|---|---|
The month (three-letter abbreviation) when DST starts, e.g. Mar |
dstStartMonth |
DSTStartMonth |
DST starting date rule3 | dstStartDateRule |
DSTStartDateRule |
The local time when DST starts, hh:mm format |
dstStartTime |
DSTStartTime |
The offset to apply during DST, (+/-)h:mm format4 |
dstAdjust1 |
DSTAdjust1 |
The month (three-letter abbreviation) when DST ends, e.g. Oct |
dstEndMonth |
DSTEndMonth |
DST ending date rule3 | dstEndDateRule |
DSTEndDateRule |
The local time when DST ends, hh:mm format |
dstEndTime |
DSTEndTime |
The offset to apply outside of DST, (+/-)h:mm format4 |
dstAdjust2 |
DSTAdjust2 |
3 The syntax for DST Rules consists of four types of expressions. The first is an integer denoting a day in a month, e.g. 10
. The second is the prefix last-
which denotes the last day of the month, e.g. lastSun
. Lastly, there are two relational operators: >=
and =<
. For example Mon>=5
denotes the first Monday of the month on or after the fifth day, while Mon<=5
denotes the first Monday of the month on or before the fifth day. For more details, see the IANA documentation on time zone syntax.
4 The values for the fields dstAdjust1
and dstAdjust2
will never both return valid time offsets. If one field returns a valid time offset in the format h:mm
, the other field will always return 0
.