List all the dispatch stop forms

Purpose: Dispatch stop forms are a set of documents or digital records that allow the fleet manager to track and mange the stops made by vehicles during their dispatch routes. They include details such as:

• stop location
• time of the stop
• purpose of the stop
• driver details
• vehicle information and others.

Use this API to fetch a information about the dispatch stops for your vehicles.

Response Parameters

forms

• Type: Array of Objects
• Description: List of forms associated with the dispatch. Each form includes details about its configuration and requirements.

id

• Type: Integer
• Description: Unique ID assigned to the form.

form_id

• Type: String
• Description: Universally unique identifier for the form.

version

• Type: Integer
• Description: The version of the form, indicating updates or changes.

title

• Type: String
• Description: A descriptive title for the form (e.g., "Arrive Shipper").

name

• Type: String
• Description: The internal name used to reference the form (e.g., "arrive_shipper").

available_for_driver

• Type: Boolean
• Description: Whether the form can be accessed or completed by the driver (e.g., false).

definition

• Type: Array of Objects

• Description: List of fields and their properties included in the form.

label

• Type: String
• Description: The display name of the field (e.g., "Bill of Lading").

name

• Type: String
• Description: The name used to identify the field in data processing (e.g., "bol").

position

• Type: Integer
• Description: The order in which the field appears in the form.

type

• Type: String
• Description: The type of data the field expects (e.g., "string").

length

• Type: Integer
• Description: The maximum number of characters allowed (e.g., 255).

required

• Type: Boolean
• Description: Whether the field must be filled out (e.g., true).

default_value

• Type: String
• Description: The value pre-filled in the field by default.