DispatchService

This service contains endpoints for dispatch functions on asset/truckload movements.

Operations

name	description
GET /dispatch/checkTrailerPreassignments/{trailerId}	Checks to see if the trailer has existing preassignments other than the current movement being checked for dispatch.
GET /dispatch/dispatchControl	Returns the user's current company's dispatch control record.
GET /dispatch/emptiesToCorrect	Determines previous empties for a given tractor, when canceling a movement.
POST /dispatch/assign/{movementId}	Assigns/updates assignments of equipment for the given movement.
POST /dispatch/cancel/{movementId}	Cancels an in-progress or delivered movement, given it is the current movement for the driver.
POST /dispatch/changeEquipment/{movementId}	Handles equipment ID changes for a given movement and specific piece of equipment.
POST /dispatch/clearPreassignments/{movementId}	Clears all preassigned equipment for the given movement.
POST /dispatch/clearStop/{stopId}	Clears the stop with the given dates and creates a service failure record if necessary.
POST /dispatch/locateTractor	Locates a tractor at the provided location.
POST /dispatch/moveTrailer	Moves the trailer to the provided location.
POST /dispatch/reconsign/{movementId}	Reconsigns the order for the given movement.
POST /dispatch/split/{splitBeforeStopId}	Splits the given movement, given the specified stop and equipment information.
POST /dispatch/unsplit/{movementId}	Unsplits the given movement.
POST /dispatch/{stopId}/acceptOffer	Handles the changes needed to be made when a driver accepts an offered stop. If the {@link DriverStopReport#getAppliesToGroup()} variable is true, then this stop plus others in the same group will be accepted together. See {@link RowStop.buildGroupingKey()} for what constitutes a group of stops. Currently, this only works for LTL movements.
POST /dispatch/{stopId}/arrive	Handles the changes needed to be made when a driver arrives at a stop. If the {@link DriverStopReport#getAppliesToGroup()} variable is true, then this stop plus others in the same group will be marked arrived together. See {@link RowStop.buildGroupingKey()} for what constitutes a group of stops. Currently, this only works for LTL movements. In the future, we will use this method for drivers to report their arrivals on truckload movements as well.
POST /dispatch/{stopId}/complete	Handles the changes needed to be made when a driver completes a delivery or pickup stop. Currently, this only works for LTL movements. In the future, we will use this method for drivers to report their starts on truckload movements as well.
POST /dispatch/{stopId}/createServiceFailure	Handles the changes needed to be made when a driver reports a service failure. If the {@link DriverStopReport#getAppliesToGroup()} variable is true, then this stop plus others in the same group will all receive service failure records. See {@link RowStop.buildGroupingKey()} for what constitutes a group of stops. Currently, this only works for LTL movements. In the future, we will use this method for drivers to report their arrivals on truckload movements as well.
POST /dispatch/{stopId}/declineOffer	Handles the changes needed to be made when a driver declines an offered stop. If the {@link DriverStopReport#getAppliesToGroup()} variable is true, then this stop plus others in the same group will be declined together. See {@link RowStop.buildGroupingKey()} for what constitutes a group of stops. Currently, this only works for LTL movements.
POST /dispatch/{stopId}/depart	Handles the changes needed to be made when a driver departs from a stop. If the {@link DriverStopReport#getAppliesToGroup()} variable is true, then this stop plus others in the same group will be marked departed together. See {@link RowStop.buildGroupingKey()} for what constitutes a group of stops. Currently, this only works for LTL movements. In the future, we will use this method for drivers to report their arrivals on truckload movements as well.
POST /dispatch/{stopId}/start	Handles the changes needed to be made when a driver starts delivering at a stop. Currently, this only works for LTL movements. In the future, we will use this method for drivers to report their starts on truckload movements as well.