Skip to content

Forms usage

Task forms can be used in many areas of business. Delivery, sales, inspections, customer surveys, field reports. The results can be used to improve certain areas of your business, concentration in an area, or market analysis. The forms can be filled out by employees using the X-GPS tracker application. Employees can fill out forms when completing tasks or sending check-ins.

Forms creation

To make it possible for employees to fill out forms, and for users to assign these forms to tasks, the form templates must be created. Let's create a form for different needs. For example, we have a delivery service. Customers order certain products, such as trackers, which are delivered and, if necessary, installed by our staff. Find form fields that will be used here.

We expect to see results on every task that's why we create a form that should be submitted only in a zone of a task. It is necessary to avoid task completion after our employee visited and spent some time in a task point. All fields we create are required to submit except one.

  • The first field will be a text field to get customer's and company's name.
  • The second text field will contain information about what was delivered to our customer.
  • The third we will use is a checkbox field where additional provided services will be checked. Minimum checked fields 1, maximum 3 and this field will be not required because if our customer will not order additional options our employee will be unavailable to send this form and complete a task. *Also, we add a signature field. It will help us to confirm that the customer received the order.

API request:

curl -X POST '' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "template": {"label": "Trackers delivery", "description": "Employee, fill this form with every delivery", "fields": [{"id": "Text-1", "type": "text", "label": "Customer's name", "required": true, "description": "Specify here customer's and company's name", "max_length": 1000, "min_length": 1}, {"id": "Text-2", "type": "text", "label": "Delivered", "required": true, "description": "Specify here all delivered models and its amount", "max_length": 1000, "min_length": 1}, {"id": "Checkbox", "type": "checkbox_group", "label": "Additional options", "description": "Specify here all provided additional options", "group": [{"label": "Presentation and training"}, {"label": "Additional configuration"}, {"label": "Installation"}], "max_checked": 3, "min_checked": 1, "required": false}, {"id": "Signature", "type": "signature", "label": "Customer's signature", "description": "Let a customer add his signature about receiving the order", "required": true}], "submit_in_zone": true, "default": true}}'

The platform will respond with:

    "success": true,
    "id": 111

Form filling

Forms can be filled in two ways:

  • Check-in. An employee sends information about his location with a filled form. Every employee of a user can choose a created form to send it with check-ins. Additional assigning is not necessary.
  • Task completion. An employee performs a task and sends a form as progress report. A form should be assigned to a task before an employee will have a possibility to fill it in a task completion zone.

Form assigning

A form can be assigned to an existing task with task update call or can be used in the process of task creation.

create_form parameter should be false to add an already created form.

Obtaining information from submitted forms

We can get submitted forms to analyze all information our employees specified in several ways.

Specific forms as they sent in tasks

  • Obtain a list of templates to get a template_id of a form we are interested in.
  • Obtain the list of tasks with the necessary form template_id and per specific time period.
  • With this task_id we can request downloading or reading the necessary form.


Specific forms as they sent in check-ins

  • Obtain a list of check-ins to get form_id we are interested in.
  • Use this form_id to read and download forms.

To get counted information in the report format

Last update: August 1, 2023