go back to DispatchService

POST /dispatch/clearStop/{stopId}

Clears the stop with the given dates and creates a service failure record if necessary.

Roles that can access this endpoint are Users.

Parameters

name description type default type
stopId ID of the stop being cleared path String
arrivalDate arrival date and time at stop query Date
departureDate departure date and time from stop query Date
delayCode service failure code if one should be created query String
delayComments service failure comments query String
causedByType type of user that caused the service failure, if one existed query String
driverId driver that caused the service failure, if one existed query String
payeeId override payee that caused the service failure, if one existed query String
userId user that caused the service failure, if one existed query String
name name of person that caused the service failure, if one existed query String
terminalId terminal where the service failure, if one existed, occurred query String
isReportable indicates if service failure, if one existed, is reportable to customer query true Boolean
faultOfCarrierOrDriver indicates if service failure, if one existed, is fault of carrier or driver query false Boolean
hub hub/odometer reading of the tractor at this stop query Integer

Result

Response of type: text/plain

a response object containing an HTTP response code and string representing success or failure of the web service call

Try It Out

Request

- Authentication Help
- String
- Date
- Date
- String
- String
- String
- String
- String
- String
- String
- String
- Boolean
- Boolean
- Integer