Jump to

• Request
• Response

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.|

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listTimezones_response

Type: object

Show Source

• 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): object sort
  Additional Properties Allowed: additionalProperties

  Sorting criteria.
• total(optional): integer
  The total number of items. Deprecated.
• totalResults(optional): integer
  The total number of items.

{
    "properties":{
        "total":{
            "description":"The total number of items. Deprecated.",
            "type":"integer"
        },
        "totalResults":{
            "description":"The total number of items.",
            "type":"integer"
        },
        "offset":{
            "description":"Index of the first element to return.",
            "type":"integer"
        },
        "limit":{
            "description":"The number of items to return.",
            "type":"integer"
        },
        "selectedTimezone":{
            "description":"Selected Timezone",
            "type":"object",
            "properties":{
                "timezoneLabel":{
                    "description":"Timezone name to display in the UI",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"ID of the timezone item",
                    "type":"string"
                },
                "timezoneCode":{
                    "description":"Standard Timezone value",
                    "type":"string"
                }
            }
        },
        "sort":{
            "description":"Sorting criteria.",
            "additionalProperties":{
                "type":"string"
            },
            "type":"object",
            "properties":{
                "property":{
                    "description":"The property the listing is sorted by.",
                    "type":"string"
                },
                "order":{
                    "description":"Sort order: asc or desc.",
                    "type":"string"
                }
            }
        },
        "items":{
            "description":"List of timezones",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "timezoneLabel":{
                        "description":"Timezone name to display in the UI",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"ID of the timezone item.",
                        "type":"string"
                    },
                    "timezoneCode":{
                        "description":"Standard Timezone values",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of timezones

Show Source

• Array of: object items

{
    "description":"List of timezones",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "timezoneLabel":{
                "description":"Timezone name to display in the UI",
                "type":"string"
            },
            "repositoryId":{
                "description":"ID of the timezone item.",
                "type":"string"
            },
            "timezoneCode":{
                "description":"Standard Timezone values",
                "type":"string"
            }
        }
    }
}

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

{
    "description":"Selected Timezone",
    "type":"object",
    "properties":{
        "timezoneLabel":{
            "description":"Timezone name to display in the UI",
            "type":"string"
        },
        "repositoryId":{
            "description":"ID of the timezone item",
            "type":"string"
        },
        "timezoneCode":{
            "description":"Standard Timezone value",
            "type":"string"
        }
    }
}

Nested Schema : sort

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Sorting criteria.",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object",
    "properties":{
        "property":{
            "description":"The property the listing is sorted by.",
            "type":"string"
        },
        "order":{
            "description":"Sort order: asc or desc.",
            "type":"string"
        }
    }
}

Sorting criteria.

Show Source

• order(optional): string
  Sort order: asc or desc.
• property(optional): string
  The property the listing is sorted by.

{
    "description":"Sorting criteria.",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object",
    "properties":{
        "property":{
            "description":"The property the listing is sorted by.",
            "type":"string"
        },
        "order":{
            "description":"Sort order: asc or desc.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  ID of the timezone item.
• timezoneCode(optional): string
  Standard Timezone values
• timezoneLabel(optional): string
  Timezone name to display in the UI

{
    "type":"object",
    "properties":{
        "timezoneLabel":{
            "description":"Timezone name to display in the UI",
            "type":"string"
        },
        "repositoryId":{
            "description":"ID of the timezone item.",
            "type":"string"
        },
        "timezoneCode":{
            "description":"Standard Timezone values",
            "type":"string"
        }
    }
}

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.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top