GET TimeZone/base

• 2 minutes to read
 • 2 minutes to read 
GET /api/v1/TimeZone/base

Base Time Zone info.

This is the time zone used internally for storing data.

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: TimeZoneData

Property Name Type Description
TZLocationID int32 Timezone location ID - primary key.
Name string Name associated with the location: Country name + region name, Norway, United States - Alaska
TZLocationCode string Code associated with location: UTC, AR-NQ, AU-QLD, PF2A Not the an ISO country code. Unique.
TZLocationCities string Cities associated with location: Oslo, London, Rio de Janeiro
IsoNumber int32 Country ISO code associated with location: 578
TimeZoneSTDRules object Dictionary of standard rules
TimeZoneDSTRules object Dictionary of Daylight saving time rules

Sample request

GET /api/v1/TimeZone/base
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "TZLocationID": 15,
  "Name": "Schuster Inc and Sons",
  "TZLocationCode": "aspernatur",
  "TZLocationCities": "quia",
  "IsoNumber": 64,
  "TimeZoneSTDRules": {
    "fieldName": {
      "StartDay": 549,
      "StartMonth": 287,
      "EndDay": 530,
      "EndMonth": 625,
      "TZOffset": 188,
      "StartRulePattern": "laudantium",
      "EndRulePattern": "quam"
    }
  },
  "TimeZoneDSTRules": {
    "fieldName": {
      "StartDay": 896,
      "StartMonth": 530,
      "EndDay": 806,
      "EndMonth": 884,
      "TZOffset": 316,
      "StartRulePattern": "quae",
      "EndRulePattern": "corporis"
    }
  }
}