Appearance
getAllTimezones ​
Retrieves a list of timezone IDs supported by SAM, primarily used for setting a user's timezone.
Request ​
http
GET /rest/refdata/timezonesQuery Parameters ​
| Parameter | Type | Required | Description |
|---|---|---|---|
countryCode | string | No | ISO country code to filter timezones. If omitted, returns all timezones. |
Examples ​
http
GET /rest/refdata/timezones
GET /rest/refdata/timezones?countryCode=AUResponse ​
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
}
]| Field | Type | Description |
|---|---|---|
timezoneId | string | IANA timezone identifier |
timezoneName | string | Display name for standard time |
timezoneDSTName | string | Display name during daylight saving time |
dstOffsetHours | integer | DST offset in hours (0 if no DST) |
offsetHours | integer | UTC offset in hours |
Errors ​
| Exception | Cause |
|---|---|
WSRefDataServiceException | Service error while fetching timezones |