• Share
    • Twitter
    • LinkedIn
    • Facebook
    • Email
  • Feedback
  • Edit
Show / Hide Table of Contents

POST Agents/TimeZone/InitializeTimeZoneData

Some tooltip text!
• 3 minutes to read
 • 3 minutes to read
POST /api/v1/Agents/TimeZone/InitializeTimeZoneData

Initalizes the TimeZoneData

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
POST /api/v1/Agents/TimeZone/InitializeTimeZoneData?$select=name,department,category/id

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:array

OK

Response Description
200 OK

Response body: array

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

POST /api/v1/Agents/TimeZone/InitializeTimeZoneData
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv

Sample response

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

[
  {
    "TZLocationID": 686,
    "Name": "Ryan-Ortiz",
    "TZLocationCode": "eos",
    "TZLocationCities": "esse",
    "IsoNumber": 243,
    "TimeZoneSTDRules": {
      "fieldName": {
        "StartDay": 685,
        "StartMonth": 807,
        "EndDay": 947,
        "EndMonth": 364,
        "TZOffset": 746,
        "StartRulePattern": "sunt",
        "EndRulePattern": "doloribus"
      }
    },
    "TimeZoneDSTRules": {
      "fieldName": {
        "StartDay": 883,
        "StartMonth": 558,
        "EndDay": 474,
        "EndMonth": 101,
        "TZOffset": 823,
        "StartRulePattern": "consequatur",
        "EndRulePattern": "repellat"
      }
    }
  }
]
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top