Click or drag to resize
POST /form/events
Print this page

The Form Event object represents a single event that is described by the eventCode and is recorded against a version of a Form.

Example of a valid request:

POST /form/events
                "formVersionId": "eb8fab4eae8b4634932f5c0e71e11463",
                "eventCode": "DVIR.3rdSignature.DriverDecidedToDriveTheFailedVehicle",
                "createTime": "2014-03-12T03:13:33Z"

The request body is a JSON array of form event objects describing the form events to be submitted:

Member Type Purpose
id string (read-only) Uniquely identifies the form event. This is an alphanumeric identifier.
formVersionId string Identifies the version id of the form this event belongs to.
eventCode string Free text event description code.
createTime string The timestamp when the event was created.
formId string (read-only) Identifies the form this event belongs to.
formVersionNumber int (read-only) Identifies the version number of the form this event belongs to.
driverName string (read-only) The name of the driver who created this event.


On success, the response body contains a JSON array of form event objects. There will be one entry in the array for each entry in the request body. Only the Id field of the Forms will be returned.

If the request fails, an Error Response is generated.