API Data Types

PrizmDoc Application Services REST API uses a data type system that is slightly more detailed and more specific than JavaScript's common data types (integer, date, and dateTime). These data types are used for defining properties of the JSON objects in the body of the POST requests and in the body of the responses where applicable.

The table below shows the supported data types by the API:

Type	Description	Example
number	Any number. This includes numbers with or without decimals.	`1000.15` or `1500`
integer	whole numbers only	`120`
boolean	true or false (without quotes)	`true` or `false`
date	This is the ISO 8601 profile for the full-date as described in the RFC 3339 section 5.6, Internet Date/Time Format. The syntax for full-date as described in this document is as `full-date = YYYY(4 digits) "-" MM(01 through 12) "-" DD(01 through 31)`	`2015-05-12`
dateTime	This is the ISO 8601 profile for the date-time as described in the RFC 3339 section 5.6, Internet Date/Time Format. The date-time syntax described in this document is `date-time = YYYY "-" MM "-" DD "T" hh(00 through 23) ":" mm(00 through 59) ":" ss(00 through 59) "Z" / ("+" / "-") hh(00 through 23) ":" mm(00 through 59)`. This profile defines two ways of handling time zone offsets: Times are expressed in UTC (Coordinated Universal Time), with a special UTC designator ("Z"). Times are expressed in local time, together with a time zone offset in hours and minutes. A time zone offset of "+hh:mm" indicates that the date/time uses a local time zone which is "hh" hours and "mm" minutes ahead of UTC. A time zone offset of "-hh:mm" indicates that the date/time uses a local time zone which is "hh" hours and "mm" minutes behind UTC.	November 5, 2015, 8:15:30 am, US Eastern Standard Time : `2015-11-05T08:15:30-05:00` Same instant in UTC : `2015-11-05T13:15:30Z`
object	A JSON object	`{"fileName": "sample.doc"}`
array	An array object	`["one", "two", "three"]`
string	A sequence of zero or more characters	`"abcdefhh"`
url	A string which is a URL	`"http://example.com"`
urlSafeBase64	A URL-safe base64 encoded string, according to RFC 4648 Section 5	`"Pqu_fKOCYd1QM5oJW6pz-suKQ-2fuxbdZtCKcApvMFVP9GGKv99crwyXTr6AZjrC5vvi3acnZVLgyEXzA"`