TimeTonic API for version 6.49q/6.49
See
History of changes
Authentication via POST
Function
Demo
Register Application (createAppkey)
createAppkey
User Login (createOauthkey)
createOauthkey
Create session key (createSesskey)
createSesskey
Drop All Sessions (dropAllSessions)
dropAllSessions
Register/Update push notification (updatePushId)
updatePushId
Access / Change Information via POST
Function
Demo
Get User Info (getUserInfo)
getUserInfo
Get user session key (getOrCreateSessKey)
getOrCreateSessKey
Get All Books Info (getAllBooks)
getAllBooks
Get info on one given book (getBookInfo)
getBookInfo
Get book messages (getBookMessages)
getBookMessages
Get (or open or play) images, media files and documents from URL
Upload images and documents (fileUpload)
Upload / resume upload where it left for images and documents (resumableUpload)
resumableUpload
Send Message (sendMsg)
sendMsg
Delete Message (deleteMsg)
deleteMsg
Get info & list of smart tables in a given book (getBookTables)
getBookTables
Get list of events in a given book (getBookEvents)
getBookEvents
Get smart table values (getTableValues)
getTableValues
Get smart table values by sync codes (getNamedTableValues)
getNamedTableValues
Get smart table value subset (getTableValueSubset)
getTableValueSubset
Get smart table reference field values (getReferenceFieldValues)
getReferenceFieldValues
Compute an operation on a smart table (computeTableOperation)
computeTableOperation
Get table rows (getTableRows)
getTableRows
Render Smart Text Field (renderSmartTextField)
renderSmartTextField
Update smart table value (updateTableValue)
updateTableValue
Create or update table row (createOrUpdateTableRow)
createOrUpdateTableRow
Create or update multiple table rows (createOrUpdateTableRows)
createOrUpdateTableRows
Delete an existing table row (deleteTableRow)
deleteTableRow
Get comments stored in smart table value (getTableValueComments)
getTableValueComments
Edit comments stored in smart table value (editTableValueComments)
editTableValueComments
Delete comments stored in smart table value (deleteTableValueComments)
deleteTableValueComments
Get table row by token(getTableRowByToken)
getTableRowByToken
Get new table row template by view token(getNewTableRowByViewToken)
getNewTableRowByViewToken
Get new table row template by view token(addNewTableRowByViewToken)
addNewTableRowByViewToken
Update table row by token(updateTableRowByToken)
updateTableRowByToken
List table rows by id(listTableRowsById)
listTableRowsById
Mark books message as read (markBooksMessagesAsRead)
markBooksMessagesAsRead
Copy or move message (copyOrMoveMessage)
copyOrMoveMessage
Rollback change on a row (rollBackBeforeChange)
rollBackBeforeChange
Get smart table pivot values (getTablePivotValues)
getTablePivotValues
Access / Change Information via Sockets
Function
Attach user to socket
Update smart table value
Send Message
(NEW / UPDATE / DELETE)
Ack Message: Receive Send message acknowledgement
Receive message
Book updates ready
Send Ping request
Ack Ping: Receive Ping request acknowledgement
Send System message
Ack System: Receive System message acknowledgement
Receive System message
Note: Use
&JSON_PRETTY_PRINT
for nice display.
TimeTonic API Demonstration
createAppkey
See
Documentation
POST /live/api.php PARAMETERS req=createAppkey&appname=api
version:
appname:
Submit
createOauthkey
See
Documentation
POST /live/api.php PARAMETERS req=createOauthkey&login=demo&pwd=test&appkey=Liqr-Wpcc-m4AU-pyV9-zwgj-4vLf-2bWk
version:
login:
pwd:
appkey:
Submit
createSesskey
See
Documentation
POST /live/api.php PARAMETERS req=createSesskey&o_u=demo&oauthkey=TaWK-Bknb-eKxd-eY2M-nuXg-qCWt-A6Mk&restrictions=
version:
oauth_user (o_u):
user (u_c):
oauthkey:
restrictions:
Submit
dropAllSessions
See
Documentation
POST /live/api.php PARAMETERS req=dropAllSessions&o_u=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl
version:
oauth_user (o_u):
user (u_c):
session (sesskey):
Submit
updatePushId
See
Documentation
POST /live/api.php PARAMETERS req=updatePushId&o_u=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl
version:
oauth_user (o_u):
user (u_c):
session (sesskey):
deviceID:
deviceType:
gcm_rid
gcm_nk
ios_dt
ios_dt_v2
bb_dt
win_uri
active:
TRUE
FALSE
registrationID:
projectID:
Submit
getUserInfo
See
Documentation
POST /live/api.php PARAMETERS req=getUserInfo&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl
version:
oauth_user (o_u):
user (u_c):
sstamp (optional):
session (sesskey):
Submit
getOrCreateSessKey
See
Documentation
POST /live/api.php PARAMETERS req=getOrCreateSessKey
version:
Submit
getAllBooks
See
Documentation
POST /live/api.php PARAMETERS req=getAllBooks&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl
version:
oauth_user (o_u):
user (u_c):
sstamp (optional):
session (sesskey):
(optional) book code (b_c):
(optional) book owner (b_o):
Submit
getBookInfo
See
Documentation
POST /live/api.php PARAMETERS req=getBookInfo&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl&b_c=test&b_o=demo
version:
oauth_user (o_u):
user (u_c):
sstamp (optional):
session (sesskey):
book code (b_c):
book owner (b_o):
Submit
getBookMessages
See
Documentation
POST /live/api.php PARAMETERS req=getBookMessages&o_u=demo&u_c=demo&b_c=test&b_o=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl
version:
oauth_user (o_u):
user (u_c):
book code (b_c):
book owner (b_o):
(optional) sstamp:
(optional) smidFirst:
(optional) smidLast :
(optional) nbMax :
(optional) page :
(optional) search_string :
session (sesskey):
Submit
resumableUpload
Click here to test resumable uploads
Test TUS Resumable Uploads
sendMsg
See
Documentation
POST /live/api.php PARAMETERS req=sendMsg&o_u=demo&u_c=demo&msg=newMessage&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl
version:
oauth_user (or telephone number of gateway) (o_u):
user (or email or telephone number) (u_c):
(optional, for edition) message id (msg_id):
(optional) book code (b_c):
(optional) book owner (b_o):
message (msg):
(optional) body (body):
session (sesskey):
event (event):
uuid (uid):
Submit
deleteMsg
See
Documentation
POST /live/api.php PARAMETERS req=deleteMsg&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl
version:
oauth_user (or telephone number of gateway) (o_u):
user (or email or telephone number) (u_c):
message id (msg_id):
book code (b_c):
book owner (b_o):
Submit
getBookTables
See
Documentation
POST /live/api.php PARAMETERS req=getBookTables&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl&b_c=test&b_o=demo
version:
oauth_user (o_u):
user (u_c):
session (sesskey):
book code (b_c):
book owner (b_o):
include extern views (externViews):
format (accepted value "android") (format):
include fields (includeFields):
include enums in fields (includeEnums):
include view/rows associations (only if format="android" and "includeFields"=true) (getRowIds):
Submit
getBookEvents
See
Documentation
POST /live/api.php PARAMETERS req=getBookEvents&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl&b_c=test&b_o=demo
version:
oauth_user (o_u):
user (u_c):
session (sesskey):
book code (b_c):
book owner (b_o):
(optional)
date mini (dateMin aaaa-mm-dd):
(optional)
date maxi (dateMax aaaa-mm-dd):
(optional)
limit (limit):
(optional)
page (page):
(optional)
events ids (events_ids):
(optional)
participants (participants):
Submit
getTableValues
See
Documentation
POST /live/api.php PARAMETERS req=getTableValues&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl&o_u_sesskey=&b_o=demo&catId=&tabId=
version:
oauth_user (o_u):
user (u_c):
session (sesskey):
o_u_session (o_u_sesskey):
book owner (b_o):
category/table id (catId):
(optional) filtered rows (filterRowIds):
(optional) tab id (tabId):
(optional) offset (offset):
(default: 100) max rows (maxRows):
(optional) format of response (format):
(optional) max comments (maxComments):
(optional) get all views (getAllViews):
(optional) get dependencies (getDependencies):
(optional) field from which linked table is accessed (fromFieldId):
(optional) json {"fieldId": "password"} to unlock encrypted field (encryptedFieldPasswords):
Submit
getNamedTableValues
See
Documentation
POST /live/api.php PARAMETERS req=getNamedTableValues&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl&b_c=test&b_o=demo&catCode=&tabId=
version:
oauth_user (o_u):
user (u_c):
session (sesskey):
book code (b_c):
book owner (b_o):
category/table sync code (catCode):
(optional) List of field sync codes (fieldCodes):
(optional) filtered rows (filterRowIds):
(optional) tab id (tabId):
(optional) offset (offset):
(default: 100) max rows (maxRows):
(optional) format of response (format):
(optional) max comments (maxComments):
(optional) get all views (getAllViews):
(optional) get dependencies (getDependencies):
Submit
getTableValueSubset
See
Documentation
POST /live/api.php PARAMETERS req=getTableValueSubset&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl&b_o=demo&catId=&fieldIds=&rowIds=
version:
oauth_user (o_u):
user (u_c):
session (sesskey):
book owner (b_o):
category/table id (catId):
fieldIds (fieldIds):
rowIds (rowIds):
Submit
getReferenceFieldValues
See
Documentation
POST /live/api.php PARAMETERS req=getReferenceFieldValues&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl&b_o=demo&fieldId=&viewId=&offset=&maxRows=
version:
oauth_user (o_u):
user (u_c):
session (sesskey):
book owner (b_o):
field id (fieldId):
(optional) tab id (tabId):
(optional) field from which linked table is accessed (fromFieldId):
(optional) offset (offset):
(optional) maxRows (maxRows):
Submit
computeTableOperation
See
Documentation
POST /live/api.php PARAMETERS req=computeTableOperation&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl&operation=count&b_o=demo&catId=&tabId=
version:
oauth_user (o_u):
user (u_c):
session (sesskey):
book owner (b_o):
category/table id (catId):
operation (operation):
(optional) filtered rows (filterRowIds):
Submit
getTableRows
(deprecated since 6.47)
See
Documentation
POST /live/api.php PARAMETERS req=getTableRows&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl&b_o=demo&catId=&tabId=
version:
oauth_user (o_u):
user (u_c):
session (sesskey):
book owner (b_o):
category/table id (catId):
(optional) specific row ids (rowIds):
(default: 100) page size (pageSize):
(default: 1) page number (page):
(optional) flag to get table info (getTableInfo):
Submit
updateTableValue
See
Documentation
POST /live/api.php PARAMETERS req=updateTableValue&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl&b_o=demo&value=&rowId=&fieldId=
version:
oauth_user (o_u):
user (u_c):
session (sesskey):
book owner (b_o):
value (value):
row id (rowId):
field id (fieldId):
(optional) Disable Webhooks (bypassUrlTrigger):
Submit
renderSmartTextField
See
Documentation
POST /live/api.php PARAMETERS req=renderSmartTextField&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl&b_o=demo&catId=&rowId=&fieldId=
version:
oauth_user (o_u):
user (u_c):
session (sesskey):
book owner (b_o):
category id (value):
row id (rowId):
field id (fieldId):
(optional) Disable Webhooks (bypassUrlTrigger):
Submit
createOrUpdateTableRow
See
Documentation
POST /live/api.php PARAMETERS req=createOrUpdateTableRow&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl&b_o=demo&view_id=&tab_id=&rowId=tmpNEW_ROW&fieldValues=""
version:
oauth_user (o_u):
user (u_c):
session (sesskey):
book owner (b_o):
row id (rowId):
field values (fieldValues):
(optional) view id:
(optional) tab id:
(optional) link separator (linkSeparator):
(optional) Disable Webhooks (bypassUrlTrigger):
Submit
createOrUpdateTableRows
See
Documentation
POST /live/api.php PARAMETERS req=createOrUpdateTableRows&o_u=demo&u_c=demo&sesskey=AP2Q-AzPK-IFM2-c4w4-qQau-HH36-cgSl&b_o=demo&view_id=&tab_id=&rows=