Skip to content

Updating task form values

Task form values can be submitted using web API only if there was a submission using Mobile Tracker App (Android / iOS). The use case is to "fix" incorrectly filled data. This action not intended to fill empty form from scratch.

API actions

API path: /task/form/values.

update

Updates existing form values of given task.

required sub-user rights: task_update.

parameters
name description type
task_id An id of the task. int
values Map of field_id-value object. JSON object

where values object is:

{
    "text1": {
      "type": "text",
      "value": "text field value"
    }
}

For value object description, see form/form-fields-and-values/.

examples

curl -X POST 'https://api.navixy.com/v2/fsm/task/form/values/update' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "task_id": "12546", "value": {"text1": {"type": "text", "value": "text field value"}}}'

response

{
    "success": true
}

errors

  • 101 – In demo mode this function disabled (if current user has "demo" flag).
  • 201 – Not found in the database (if task with the specified id does not exist).
  • 255 – Invalid task state (if task has already done or failed or no values submitted).
  • 242 – There were errors during content validation (if given values are invalid for the form). Example:
{
    "success": false,
    "status": {
        "code": 242,
        "description": "There were errors during content validation"
    },
    "errors": [
        {
            "field_id": "111-aaa-whatever",
            "code": 5,
            "error": "text length constraints are not met"
        }
    ]
}

Validation error codes:

  • 1 – field required but has no value.
  • 2 – field value type doesn't match field type.
  • 3 – field value is null.
  • 4 – value index out of bounds.
  • 5 – invalid value size.
  • 6 – value less than minimum.
  • 7 – value more than maximum.
  • 8 – field contains invalid references.
  • 9 – invalid file type.
  • 10 – invalid file state.

Last update: November 25, 2020