listTimezones
get
/ccadmin/v1/timezones
List Timezones. Get a list of timezones and the currently selected timezone.
Request
Supported Media Types
- application/json
Query Parameters
-
limit(optional): integer
The number of items to return.
-
offset(optional): integer
Index of the first element to return.
-
sort(optional): string
Sorting criteria. Following are the fields supported by this param: |Field|Type|Description| |------------------|------------------|------------------| |property|string|The property the listing is sorted by.| |order|string|Sort order: asc or desc.|
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listTimezones_response
Type:
Show Source
object
-
items(optional):
array items
List of timezones
-
limit(optional):
integer
The number of items to return.
-
offset(optional):
integer
Index of the first element to return.
-
selectedTimezone(optional):
object selectedTimezone
Selected Timezone
-
sort(optional):
array sort
Sorting criteria.
-
total(optional):
integer
The total number of items. Deprecated.
-
totalResults(optional):
integer
The total number of items.
Nested Schema : selectedTimezone
Type:
object
Selected Timezone
Show Source
-
repositoryId(optional):
string
ID of the timezone item
-
timezoneCode(optional):
string
Standard Timezone value
-
timezoneLabel(optional):
string
Timezone name to display in the UI
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
ID of the timezone item.
-
timezoneCode(optional):
string
Standard Timezone values
-
timezoneLabel(optional):
string
Timezone name to display in the UI
Nested Schema : items
Type:
Show Source
object
-
order(optional):
string
Sort order: asc or desc.
-
property(optional):
string
The property the listing is sorted by.
Example Response (application/json)
{
"total":107,
"totalResults":107,
"offset":3,
"limit":3,
"selectedTimezone":{
"timezoneLabel":"(UTC) Reykjavik ",
"repositoryId":"atlantic_reykjavik",
"timezoneCode":"Atlantic/Reykjavik"
},
"sort":[
{
"property":"timezoneLabel",
"order":"asc"
}
],
"items":[
{
"timezoneLabel":"(UTC) London ",
"repositoryId":"europe_london",
"timezoneCode":"Europe/London"
},
{
"timezoneLabel":"(UTC) Nouakchott ",
"repositoryId":"africa_nouakchott",
"timezoneCode":"Africa/Nouakchott"
},
{
"timezoneLabel":"(UTC) Reykjavik ",
"repositoryId":"atlantic_reykjavik",
"timezoneCode":"Atlantic/Reykjavik"
}
]
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|80023|There was an error fetching the timezone list.|
|80028|Null sort directive entry found in sort directives list. Null entries are not allowed.|
|80027|xx is a restricted property to use for sorting timezones.|
|80026|xx is an invalid sort property as it is not a property found for timezone|
|80021|There was an error retrieving the selected timezone.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code