JSON Data Conventions

TrackTik's API features some common datatypes that can be learned without needing to refer to additional documentation. The following are the most common and useful to become familiar with:

Datatypes

DatatypeContextConstraints
StringTitle, ID, Label255 characters
StringDescription, Post, Memo65535 characters
BooleanAlltrue|false
IntegersID4 bytes, signed -2,147,483,648 to 2,147,483,648 (without commas)
CurrencyMostn…n.nn (padded)
Billing rateMostn…n.nn (unpadded)
RatesBilling and payrolln…n.nnnn
DateAllyyyy-mm-dd
DateTimeMostyyyy-mm-dd hh:mm:ss
24h format
DateTime with TimezoneMostyyyy-mm-ddThh:mm:dd+hh:mm
T is literal, +hh:mm is an offset
Empty FieldMostnull
Literal text “null”

Formatting

FieldContextBehaviour
TextSpecial charactersSpecial characters are escaped with the \ character. 
E.g.
"\"Escaping text.\" - normal quotes
TextInternational charactersNo change.
E.g.
Caractères français
TextCarriage returns / 
Line Feeds
Guarding Suite and Guard Tour interpret \r\n as carriage return and line feed pairs.
E.g.
line 1\r\nline2
TextCurly quotesPreserved as entered

 

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

See more