Qodex.ai

Create Timing

POST {{baseUrl}}/v1/timing

Timing might be a misleading name (apologies), but it has nothing to do with scheduling content. Timing is an endpoint that will allow you to set your Applet on device.

Create new Timing record for deploying selected Applet and to the target device.

Parameters

FieldTypeRequiredDescription
no query parameters

Body

content-type: application/json or application/x-www-form-urlencoded

FieldTypeDescription
deviceUidstringUnique device identification
appletUidstringApplet unique identification
appletVersionstring (semver)Version of your applet
startsAtDate YYYY-MM-DDTHH:MM:SS.sssSince when the Applet should be set on device e.g. 2017-11-22T09:26:49.246
endsAtDate - YYYY-MM-DDTHH:MM:SS.sssUntill when the Applet should be set on device e.g. 2017-11-22T09:26:49.246
configurationJSONUnique configuration specific to the applet and device, usually your internal ID’s, links to APIs, etc.
positionnumberWhen more then one Applet is set for device, in which order are they available on the device
finishEventTypestring - ‘DURATION’ , ‘SCREENTAP’ , ‘IDLETIMEOUT’Which event is triggering switch between multiple Applets‘DURATION’ – after specific amount of time‘SCREENTAP’ – after display is touched‘IDLETIMEOUT’ – after time of inactivity (without any tapping on display)
finishEventDataanyused for setting DURATION or IDLE_TIMEOUT values of finishEventType

Remarks on startsAt and endsAt

  • When you set endsAt to timing, it sticks to the device until the applet with the later startsAt date is in the system. In most cases you will set startsAt and endsAt date to the same value.
  • configuration values have to be always a key-value pairs where value is a string. To pass JSON object use JSON.stringify().

HEADERS

KeyDatatypeRequiredDescription
x-authstringAuthorization key and token
Content-Typestring
Content-Typestring
Acceptstring

RESPONSES

status: OK

{}