The Fabrick Platform APIs adopt the following data formats:
String
API Version 1.0 to 3.0:
API Version 4.0:
Default format: -
Notes: -
Example: "A string"
Number
API Version 1.0 to 3.0:
API Version 4.0:
Default format: #.#
Notes: -
Example: 12.56
Boolean
API Version 1.0 to 3.0:
API Version 4.0:
Default format: true
| false
Notes: -
Example: true
Object
API Version 1.0 to 3.0:
API Version 4.0:
Default format: {...}
Notes: -
Example: {"stringField": "A string in an object"}
Array
API Version 1.0 to 3.0:
API Version 4.0:
Default format: [...]
Notes: -
Example: ["elem1", "elem2"]
Enumeration
API Version 1.0 to 3.0:
API Version 4.0:
Default format: {"enumeration": "", "value": ""}
Notes: enumerations can be resolved using the API endpoints contained in the Platform Utils package.
Example: {"enumeration": "ENUM_NAME", "value": "ENUM_NAME_01"}
Date
API Version 1.0 to 3.0:
API Version 4.0:
Default format: YYYY-MM-DD
Notes: Follows ISO 8601 standard, with X-Time-Zone
header.
Example: 2019-03-31
Datetime
API Version 1.0 to 3.0:
API Version 4.0:
Default format: YYYY-MM-DDThh:mm:ss.sssZ
Notes: Follows ISO 8601 standard.
Example: 2019-03-31T12:49:25.451Z
Timestamp
API Version 1.0 to 3.0:
API Version 4.0:
Default format: [0-9]{13]
Notes: Milliseconds since Unix epoch (Jan 1, 1970 00:00:00 UTC).
Example: 1550230023518
CountryCode
API Version 1.0 to 3.0:
API Version 4.0:
Default format: [A-Z]{2}
Notes: Follows ISO 3166-1 alpha 2 standard.
Example: IT
Currency
API Version 1.0 to 3.0:
API Version 4.0:
Default format: [A-Z]{3}
Notes: Follows ISO 4217 standard.
Example: EUR