Custom Data Types (2020/10)

The data types below, which are consistent across all APIs, are used in the Main API as are the entities in the child pages beneath this page.


Defines a moment in time using a sortable UTC pattern value format, based on rfc3339. An example would be 2022-02-18T16:57:00.123Z 


Represents the day of the week from Sunday to Saturday. The days are specified as a string list (for example, "Monday, Wednesday, Friday").  



Data types that are prefixed with "nullable" (for example, nullable<int>) accept null value. Most data types are not nullable in this API framework, so this data type allows you to accept null for a non-nullable type. By default, nullable types are strings, objects, and arrays.


Represents a period of time. Possible values are: 

  • 00:00 - 23:59 (hours and minutes)
  • 00:00:00 - 23:59:59 (hours, minutes, and seconds. This is the default format)
  • 00:00:00.000 - 23:59:59.999 (hours, minutes, seconds, and milliseconds)
  • 1.00:00:00 - 99999.23:59:59 (date, hours, minutes, seconds)
  • 1.00:00:00.000 - 99999.23:59:59.999 (date, hours, minutes, seconds, and milliseconds)


A representation of a resource available on the internet or intranet. This data type is nullable.