View Timezone

GET /timezones/{id}
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/timezones/{id}

Retrieves the details of a Timezone if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique id of the timezone. Example NST.


Example: id=NST
query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
viewstring
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.


Example: view=full/default

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ timezone ]
An array of all created items.
Timezone
Name
Description
codestring
Three-letter, uppercase timezone code.


Example: NST
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
idstring
A unique identifier generated by the Ocamba platform.


Example: NST
namestring
Full name of the timezone.


Example: New Zealand Standard Time
offsetstring
Full representation of hours a certain time zone is ahead of or behind GMT.


Example: GMT+12:00
short_offsetnumber (integer)
Short representation of hours a certain time zone is ahead of or behind GMT.


Example: 12
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the timezone id, list the timezones to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 1,
    "items": [
        {
          "id": "NST",
          "code": "NST",
          "name": "New Zealand Standard Time",
          "short_offset": 12,
          "offset": "GMT+12:00",
          "create_time": "2021-01-22 10:00:28",
          "update_time": "2021-01-22 12:45:02"
        }
    ]
}

{
  "total": 1,
  "items": [
    {
      "id": "NST",
      "code": "NST",
      "name": "New Zealand Standard Time",
      "short_offset": 12,
      "offset": "GMT+12:00",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}