Submit Dispatch Schedule

Schedules drivers to specific vehicles over specified periods, facilitating efficient fleet management. Unlike the Driver Assignment API, which tracks actual driver usage of vehicles, this API focuses solely on planned schedules.

Below is the reference list of validation response codes that can be found in response after submitting dispatch schedule:

  • "SUCCESS" - Success
  • "E_UNKNOWN" - Unknown error processing entry
  • "E_NO_MATCH" - No matching entry found
  • "E_NO_MATCH_DRIVER" - No matching entry found for Driver
  • "E_NO_MATCH_VEHICLE" - No matching entry found for Vehicle
  • "E_ACCESS_DENIED" - Access has been denied to one or more objects in this operation
  • "E_CREATE_USER_ACCESS_DENIED" - Access has been denied while attempting to create a new user object
  • "E_DUPLICATE_USERNAME_OR_EMPLOYEENUM" - The UserName field or EmployeeId field matches an existing active user
  • "E_CREATE_USER_INCLUDE_SPECIAL_CHARACTER - The FirstName field, LastName field or EmployeeId field include special character
  • "I_CREATE_USER_SUCCESS" - The user was successfully created
  • "I_DUPLICATE_RULE" - A rule was added to the system that is a duplicate of an existing rule. The previous rule has been removed
  • "E_CONFLICTING_SCHEDULE" - Another schedule with similar schedule details was found, or was recently processed
  • "E_FIRSTNAME_OR_LASTNAME_NOT_ALLOW_NULL" - The FirstName and LastName fields are required while auto adding driver
  • "E_DUPLICATE_VEHICLES" - Could not identify the vehicle because there are multiple vehicles using the same vehicle name in company
SecuritybearerAuth
Request
Request Body schema: application/json
validate
boolean

Default to false. if set to true, only validate the submission request otherwise validate and process the submission logs

autoAddDriver
boolean

Default to true.

If driver is not found based on userIdentifier and autoAddDriver is set to true, It will try to add new driver based on information provided in user object.

If autoadddriver is set to false and driver not found based on userIdentifier then no new driver is created

Array of objects or null (DispatchEntry)
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/v1/driver-assignments/dispatch
Request samples
application/json
{
  • "validate": false,
  • "autoAddDriver": true,
  • "entries": [
    ]
}
Response samples
application/json
{
  • "data": {
    }
}