Creates a new event and returns its id.

SecurityAPIKey
Request
Request Body schema: application/json
vehicleId
integer <int64> [ 1 .. 9223372036854780000 ]

Vehicle identifier associated to event.

deviceViewIds
Array of integers or null <int64>

List of device view identifiers associated with event.

requestedStartDate
string or null <date-time>

Event start time.

requestedEndDate
string or null <date-time>

Event end time.

label
string or null

User defined event identifier or description. Typically used to give events a user-friendly name.

typeId
integer <int32> [ 1 .. 10 ]

Indicates the type of event. Possible values: 4 (for clip) or 7 (for tags). Default value is 4.

subTypeId
integer or null <int32>

Indicates the type of tag. Used only when the event type is a tag. Possible values: 3 (Custom) or leave parameter unpopulated when not creating a tag event.

eventTime
string <date-time>

Time of event. The EventTime should be the same as RequestStartTime when an event is a clip. When the event is a tag, EventTime is the point of interest.

Responses
201
400

The parameters given in the request are invalid.

401

Access is denied. This can occur from an invalid key or invalid pod.

403

Access is denied to create an event. The given API key's context does not have the proper permissions.

post/events
Request samples
application/json
{
  • "vehicleId": 1,
  • "deviceViewIds": [
    ],
  • "requestedStartDate": "2019-08-24T14:15:22Z",
  • "requestedEndDate": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "typeId": 4,
  • "subTypeId": null,
  • "eventTime": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "id": 0
}