Data Formats

GET, DELETE, and copy requests carry their data in the URL and never have a request body. All other requests and all responses are always in JSON format.

Dates

Dates are provided in and expected in a few supported ISO 8601 extended formats generally with a date portion (yyyy-mm-dd) and time portion (hh:mm:ss) separated by the letter T as a delimiter. The time may optionally be followed by a UTC indicator Z or a UTC offset (±hh:mm).

• The date portion (yyyy-mm-dd) includes:
  • yyyy refers to a four-digit year (note that the earliest year supported in our system is 1754)
  • mm refers to a zero-padded month between 00 and 12
  • dd refers to a zero-padded day of the specified month 01 to 31 (but not to exceed the last day of the specified month)
• The time portion (hh:mm:ss) includes:
  • hh refers to a zero-padded hour between 00 and 23
  • mm refers to a zero-padded minute between 00 and 59
  • ss refers to a zero-padded second between 00 and 59
• The optional UTC indicator (Z or ±hh:mm) includes:
  • A Z indicator for UTC (i.e. zero UTC offset)
  • ± refers to a plus (+) or minus (-) symbol indicating if the offset is before (-) or after (+) UTC
  • hh refers to a zero-padded hours offset from UTC
  • mm refers to a zero-padded minutes offset from UTC

Examples of date formats that may be encountered while using the API

• yyyy-mm-ddThh:mm:ss (e.g. 2016-05-15T18:29:34)
• yyyy-mm-ddThh:mm:ssZ (e.g. 2016-05-15T18:29:34Z)
• yyyy-mm-ddThh:mm:ss±hh:mm (e.g. 2016-05-15T18:29:34-04:00)

Time Zone Property

• Most payloads will include a TimeZone property that will specify a time zone for date time values in that payload.
• Requests that do not include a time zone or have the time zone set to null will assume the payload time zone is the time zone configured for the user making the request. Note that this is not the time zone of a user's local computer this is the time zone configured in our system for the user.
• Responses will have a time zone that matches the time zone configured for the user making the request. Note that this is not the time zone of a user's local computer this is the time zone configured in our system for the user.