Delete Trip
Trip Management’s Delete Trip API lets you remove a previously generated route.
The following two variations of requests are supported for this functionality:
DELETE /trip/{tripId}
Resource URL
https://tripmanagement.alk.com/api/trip/{tripId}
Request Fields
Field | Description | Type | |
---|---|---|---|
tripId
| The alkTripId returned when you planned the trip.
|
integer | Yes |
DELETE /trip?tripId={tripId}
Resource URL
https://tripmanagement.alk.com/api/trip?tripId={tripId}
Request Fields
Field | Description | Type |
---|---|---|
tripId
| The 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.
|
integeror string |
Response Fields
Same response for both the types of requests
Field | Description | Type |
---|---|---|
success
| True if the route was deleted; false if not. |
boolean |
message
| Contains the reason the message was not sent if success = false. |
string |
Sample Response
{
"success": true,
"message": null
}