« Return to Index
Glossary
Data types
Entities in the IA database all fall into one of the following data types:
Type | Description |
---|---|
integer | Whole number, usually signed. |
float | Floating point/decimal number. |
string | String with up to 255 characters, encoded in UTF-8. |
text | String storing up to 64KiB unless otherwise noted. Encoded in UTF-8. |
boolean | True or False. Typically represented as a integer values 1 or 0 |
datetime | Date + Time in YYYY-MM-DD HH:MM:SS format. Timezone is always Australia/Brisbane (UTC + 10 hours with no daylight savings). |
date | Date in YYYY-MM-DD format. Timezone is undefined (just display the date as is, regardless of the user's timezone). |
json | Set of values encoded in JSON format. Note: when embedding JSON inside JSON the child value must be in a string with any applicable escaping. For example: {"custom_field_values_json": "{\"store_name\":\"Atherton IGA\"}"} |
binary | raw binary data encoded in Base 64, as a JSON string. Typically used for JPEG or PDF documents. For example: "VGhpcyBpcyBhbiBlbmNvZGVkIHN0cmluZw==" represents the ASCII string "This is an encoded string". |
Access Levels
Level | Description |
---|---|
Read Only | this entity or value can be read, but not written. Some read only values be set during an insert operation. |
Read + Write | this entity or value can be read or written to |
Inspection Apps API Documentation « Return to Index