Once you have created a Clock, you will need to assign Clock Events to it, which will then enable it to work with our Traffic engine. Clock Events can be of 5 different event types, which are Avail Blocks, Programs, Announcements, Comments or Automation Commands. Our Traffic engine treats each type differently, so it is important you add the correct type of event.
Beware!
POST, PUT & DELETE methods require an additional scope to be granted, more information on the
edit-logs
scope can be found in the scope documentation.
A warning about event types.
Not all event types are supported by all automation systems, when an event type is not supported by the users automation system, we simply drop that event when creating the users log.
The Event Object
Key | Datatype | Notes |
---|---|---|
| int | A valid |
| int | Primary ID for the event. |
| string | Time of the Log Event in 24 hour time. eg 23:55:30 |
| int | The length of the event in seconds. eg |
| string |
|
| int |
|
| string |
|
| int |
|
| int | 0 - 255 |
| int |
|
| int |
|
| int |
|
| int | An |
| array | An |
| int | An |
| string | How many hour, minutes and seconds the repeated events are seprated by. |
| string |
|
| string |
|
{
"clockId": 17,
"coreId": 456,
"time": "23:55:30",
"timeInterval": "01:30:00",
"timesToRun": 3,
"comment": "SPOT BLOCK(3:00)",
"command": "",
"cartId": "",
"length": "00:03:00",
"availType": 0,
"programType": 0,
"announcementType": 0,
"priority": 233,
"required": 2,
"source": 1,
"eventType": 2,
"allowedUnits": 2,
"allowedLengths": [
30,
60
]
}