Data types
The RamBase API is using several datatypes in query parameters, filters, request- and response body.
1. DateTime
DateTime follows the ISO-8601 format and is defined in UTC/GMT time.
Format
yyyy-MM-ddTHH:mm:ss±hh:mm yyyy-MM-ddTHH:mm:ssZ yyyy-MM-ddTHH:mm:ss |
Example
2022-02-01T02:00:00 (Local time) 2015-01-01T22:00:00Z (UTC) 2014-01-01T12:00:00+01:00 (UTC offset) |
Time zones in ISO 8601 are represented as local time (with the location unspecified), as UTC, or as an offset from UTC.
Local time in the RamBase API is Central European Time (CET) or Central European Summer Time (CEST), depending on the time of year. CET is 1 hours ahead of Coordinated Universal Time (UTC), while CEST is 2 hours ahead. If no UTC relation information is given with a time representation, the time is assumed to be in local time.
While it may be safe to assume local time when communicating in the same time zone, it is ambiguous when used in communicating across different time zones. It is usually preferable to indicate a time zone (zone designator) using the standard's notation. If the time is in UTC, add a Z directly after the time without a space. Z is the zone designator for the zero UTC offset. The UTC offset is appended to the time in the same way that 'Z' was above, in the form ±[hh]:[mm]. All output from the RamBase API is with UTC offset.
2. Date
Date follows the ISO-8601 format
Format yyyy-MM-dd |
Example 2014-01-01 |
3. Time
Time follows the ISO-8601 format
Format HH:mm:ss |
Example 12:00:00 |
4. Integer
Positive and negative whole numbers. Specific fields on resources may have additional limitations on the accepted minimum and maximum values. Both examples below are equivalent.
Minimum value -2,147,483,648 |
Maximum value 2,147,483,647 |
Example 12345 |
Example 12,345 (results in 12345) |
5. Long
Larger numbers than integer. Specific fields on resources may have additional limitations on the accepted minimum and maximum values. Both examples below are equivalent.
Minimum value –9,223,372,036,854,775,808 |
Maximum value 9,223,372,036,854,775,807 |
Example 123456789012345 |
Example 123,456,789,012,345 |
6. Decimal
Decimal value, using a dot "." as the decimal mark.
Note: The comma "," is NOT treated as a decimal mark and will be ignored
Example 123.456 (results in the value 123.456) |
Example 123,456 (valid but results in the value 123456) |
7. Boolean
Allows the values "True" or "False"
8. String
Text as a sequence of characters