REST API for Oracle Commerce Cloud December 2017

getTimezone

get

/ccadmin/v1/timezones/{id}

Get Timezone. Get a single timezone item for the provided id

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The ID of the requested timezone.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getTimezone_response

Properties

repositoryId: Type: string

ID of the timezone item
timezoneCode: Type: string

Standard Timezone value
timezoneLabel: Type: string

Timezone name to display in the UI

Example application/json


{
    "timezoneLabel":"(GMT+00:00) Dublin - Greenwich Mean Time (GMT) ",
    "repositoryId":"europe_dublin",
    "timezoneCode":"Europe/Dublin"
}

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| |------------------|------------------| |80020|Timezone could not be found for timezoneId xxx|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "timezoneLabel": "(GMT+00:00) Dublin - Greenwich Mean Time (GMT) ",
  "repositoryId": "europe_dublin",
  "timezoneCode": "Europe/Dublin"
}