Form
Structured information collected from a field employee when they complete a task or check in.
A form collects structured information from a field employee at the moment they finish something: a customer's name, a delivery date, a signature, a photo. It is filled from the Mobile Tracker App, and a form attached to a task blocks that task from completing until it is submitted.
A form is single-use. Each one is created from a template and, once filled, is stored with its values for good. That separation is deliberate: a template can change over time without altering any form already filled from it.
This API only attaches and fills forms on tasks. Check-in forms are created from the mobile application. For working with task forms, see Task forms, and for the field and value structures, see Form fields and values. For a walkthrough, see how to use task forms.
Form object
The fields and values entries are described in Form fields and values.
Form file object
API actions
API base path: /form.
Return a form by ID, together with the files used in its values.
Also accepts GET with the same parameters as query-string values.
Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.
ID of the form.
The form and its files
true if request finished successfully.
trueBad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.
Error response object
POST /v2/form/read HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 8
{
"id": 1
}{
"success": true,
"value": {
"id": 1,
"label": "text",
"description": "text",
"fields": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"created": "text",
"submit_in_zone": true,
"task_id": null,
"checkin_id": null,
"tracker_id": null,
"template_id": null,
"template_version": null,
"values": null,
"submitted": null,
"submit_location": {
"lat": 1,
"lng": 1,
"address": "text"
}
},
"files": [
{
"id": 1,
"storage_id": 1,
"user_id": 1,
"type": "image",
"created": "text",
"uploaded": null,
"name": "text",
"size": 1,
"mime_type": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"state": "created",
"download_url": null,
"bindings": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"previews": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
}
]
}Errors
These errors come in addition to the general error codes:
201 - Not found in the database - if there is no form with such an ID.
Return a form rendered as a file.
The response is the file itself, not a JSON envelope, unless an error occurs.
Also accepts GET with the same parameters as query-string values.
Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.
ID of the form.
File format of the rendered form.
The rendered form file
Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.
Error response object
POST /v2/form/download HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"id": 1,
"format": "pdf"
}binaryErrors
These errors come in addition to the general error codes:
201 - Not found in the database - if there is no form with such an ID.
More in this section
Form templates
Last updated
Was this helpful?