Date/Times
All of the date/time objects within our REST API are String variables in the format ISO-8601. This is the standard format utilized by the OpenAPI specification, but it also provides a host of other benefits, including:
- Natural sorting — It sorts in any language without any additional work.
- Time zone support — Since the timestamp specifies the time zone, it can be converted to the user's local time with minimal work in most languages.
- Locale neutral — There is no ambiguity about the order in which the date/time components appear for an ISO-8601 string. You can use your language's libraries to format it in the locale-specific way for display.
- Language support — Because ISO-8601 is used in standards published by the W3C and the IETF, every major language has mature libraries available for parsing ISO-8601 formats. Don't reinvent the wheel on this one!
Was this page helpful?