Send Trip

The Send Trip API is a service to dispatch a previously planned trip to CoPilot. The Trip ID has to be supplied in the API request and the response will indicate if the dispatch was success or not along with a message.

Note: Route Adherence options will be already set during trip planning using Plan Trip API.

The following two variations of requests are supported for this functionality:

GET /trip/{tripId}/send

Request Fields

FieldDescriptionTypeRequired
tripIdThe alkTripId returned when you planned the trip.integerYes

GET /trip/send?tripId={tripId}

Request Fields

FieldDescriptionTypeRequired
tripIdThe alkTripId returned when you planned the trip or the tmsTripId in your planning system.
Note: Only one can be used when making a request through the URL. The search logic will check for the user’s trips with matching tmsTripId. If no trips are found with provided tmsTripId, then the check will continue for trips with matching alkTripId. If no trip is found matching with either of the Trip IDs, then no trip found response will be returned.
integer or stringYes

Response Fields

Same response for both the types of requests

FieldDescriptionType
successTrue if the route was sent successfully; false if not.boolean
messageContains the reason the message was not sent if success = false.string

Sample Response

{
  "success": true,
  "message": null
}