This service is used to submit one or more forms. These forms contain the response data that a driver provided for each form item. A form can be updated until it has been set to read only. Forms that do not support multiple versions become read only when first saved with the Submitted status.

The ability to store multiple versions is controlled by the form template.

Example of a request that creates a new Submitted form:

POST /forms
[  
   {  
      "id":"26fc499ae0784cab94ce4adddf4d7a93",
      "template":"72fed18ca98445bdb31b5c545ccb7bb0",
      "versionId":"8618d37b265b40d8b8809c5e1046d399",
      "values":"<instance name=\"abc\" loc=\"-43.5441624,172.5914094\"><textbox name=\"Text\" id=\"2\" required=\"false\">foo<\/textbox><\/instance>"
   }
]

Example of a request that creates a Saved (draft) form:

POST /forms
[  
   {  
      "id":"cd63e0e3be174550919ad6752ad15f42",
      "template":"72fed18ca98445bdb31b5c545ccb7bb0",
      "versionId":"935d3435153c4306a37781811618204a",
      "status":"Saved",
      "submissionTime":"2016-08-23T01:01:01Z",
      "values":"<instance name=\"abc\" loc=\"-43.5441624,172.5914094\"><textbox name=\"Text\" id=\"2\" required=\"false\">initial value<\/textbox><\/instance>"
   }
]

Example of a request that updates a form by posting a revision with the same id. The previousVersionId must refer to the versionId of the most recent revision:

POST /forms
[  
   {  
      "id":"cd63e0e3be174550919ad6752ad15f42",
      "template":"72fed18ca98445bdb31b5c545ccb7bb0",
      "versionId":"275703de682a4e218765e188288bc2f1",
      "previousVersionId":"935d3435153c4306a37781811618204a",
      "status":"Submitted",
      "submissionTime":"2016-08-23T01:23:17Z",
      "values":"<instance name=\"abc\" loc=\"-43.5441624,172.5914094\"><textbox name=\"Text\" id=\"2\" required=\"false\">new value<\/textbox><\/instance>"
   }
]

Note
To save a new version of a form, the form's id and the XML's versionId property must be specified in the JSON request body. The versionId should be kept from the previous version's XML.

• If an id is supplied, then the service interprets the request as a create or update request. If no form instance exists with the specified id, then a new form instance is created. Otherwise, the existing form instance is updated.
• If you post a form and do not specify an id, then the service creates a new form instance and assigns it a new unique id. However, this is legacy behavior, and we do not recommend it. The best practice is to supply an id with all create and update requests.
• Multiple versions of the same form can be submitted in a single request if the request includes the previousVersionId for each revision. Forms are processed in the order that they are submitted and must be sorted accordingly.
• If a form is marked as "read only" it cannot be updated.
• When reading from the server, all of the following GUID properties are formatted as alphanumeric strings, without dashes: id, versionId, previousVersionId, and template. When posting to the server, these GUID properties are allowed to contain dashes.
• When posting a form, the submissionTime must be unique. If this property has the same value as a previous revision, then the request is ignored.

The Request body is a JSON array of form objects describing the forms to be submitted:

On success, the response body contains a JSON array of form objects. There will be one entry in the array for each entry in the request body. Only the id, versionId, versionNumber, and readOnly properties of the Forms are returned.