go back to CarrierDispatchService

POST /carrierDispatch/clearStop/{stopId}

This method clears the specified stop using the parameters given.

Roles that can access this endpoint are Users.

Parameters

name description type default type
stopId ID of the stop to be cleared path String
arrivalDate date of arrival at the stop query Date
departureDate date of departure from the stop query Date
delayCode code representing the reason for a service failure, if one existed query String
delayComments comments representing reason for a service failure, if one existed 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

Result

Response of type: text/plain

a response containing the success or failure of the clear stop request

Try It Out

Request

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