Contact us Login LIVE DEMO FREE TRIAL

list(..)

Returns descriptions of forms, created on the basis of specified form template. In addition to the data on the forms, the list contains data on the objects related to each form – tracker / vehicle / employee, task.

parameters:

  • form_template_id (integer, required). The returned list will contain forms, related to that template.
  • order_by (optional, default = submitted). Data field for list sorting. Available values:
    • task_id
    • created
    • submitted
    • task_address
    • submit_address
    • employee_full_name
    • vehicle_label
    • tracker_label
    • task_label
    • form_label
    • form_description
  • ascending (boolean, required). Sorting direction (ascending / descending).
  • include_unsubmitted (boolean, required). If true, unsubmitted forms shall be included in the list.
  • filters (object, optional). Specifies the criteria for filtering the list based on the values of the data fields. Conditions are combined by logical AND.\ Filters object contains following optional elements:
    {
        "employee_full_name": , // a sequence of characters for partial matching (against the name of the associated employee)
        "form_description": ,
        "form_label": ,
        "submit_address": ,
        "task_id":  // strict match
        "task_address": , 
        "task_label": ,   
        "tracker_label": , 
        "vehicle_label": ,
    }
    
  • submit_period (object, optional).
    {
      "from": ,
      "to": 
    }
    
  • offset, limit (integers, optional). Specify which subset of elements from all matching results will be included in the returned list.

return:

{
  "success": true,
  "count": N,
  "list": [
    {
      "employee": {
        "id": 13,
        "first_name": "John",
        "middle_name": "",
        "last_name": "Dow"
      },
      "task": {
        "id": 7867,
        "label": "My task 3",
        "from": "2017-07-27 15:00:00",
        "to": "2017-07-28 14:59:59",
        "address": "B",
        "status": "failed"
      },
      "tracker": {
        "id": 15620,
        "label": "Navixy A6"
      },
      "vehicle": null,
      "form": {
        "id": 1012,
        "label": "A form",
        "description": "",
        "fields": [],
        "created": "2017-07-28 03:48:06",
        "submit_in_zone": false,
        "task_id": 7867,
        "template_id": 449,
        "values": null,
        "submitted": null,
        "submit_location": {
          "lat": 0.0,
          "lng": 0.0,
          "address": null
        }
      }
    },
    ...
  ]
}

errors:

  • 204 – Not found (if there is no form template with such id belonging to authorized user)
  • General types of errors.

If you have more questions please contact our support team

Contacts

USA: +1 858 815 9045

Mexico: +52 334 1642158

UK: +44 808 1641499

Germany: +49 1573 5988250

Russia: +7 495 223 0427

Log in

Login

[clean-login]

CLOSE
Register

[clean-login-register]

CLOSE
Loading...