Skip to content

getAllTimezones ​

Retrieves a list of timezone IDs supported by SAM, primarily used for setting a user's timezone.

Request ​

http
GET /rest/refdata/timezones

Query Parameters ​

ParameterTypeRequiredDescription
countryCodestringNoISO country code to filter timezones. If omitted, returns all timezones.

Examples ​

http
GET /rest/refdata/timezones
GET /rest/refdata/timezones?countryCode=AU

Response ​

200 OK ​

json
[
  {
    "timezoneId": "Antarctica/Macquarie",
    "timezoneName": "(GMT +11) Macquarie Island Standard Time",
    "timezoneDSTName": "(GMT +11) Macquarie Island Daylight Time",
    "dstOffsetHours": 0,
    "offsetHours": 11
  },
  {
    "timezoneId": "Australia/Sydney",
    "timezoneName": "(GMT +10) Australian Eastern Standard Time",
    "timezoneDSTName": "(GMT +11) Australian Eastern Daylight Time",
    "dstOffsetHours": 1,
    "offsetHours": 10
  }
]
FieldTypeDescription
timezoneIdstringIANA timezone identifier
timezoneNamestringDisplay name for standard time
timezoneDSTNamestringDisplay name during daylight saving time
dstOffsetHoursintegerDST offset in hours (0 if no DST)
offsetHoursintegerUTC offset in hours

Errors ​

ExceptionCause
WSRefDataServiceExceptionService error while fetching timezones