DispatchService

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

Operations

name	role	description
GET /dispatch/checkTrailerPreassignments/{trailerId}	Users	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	Users	Determines previous empties for a given tractor, when canceling a movement.
POST /dispatch/assign/{movementId}	Users	Assigns/updates assignments of equipment for the given movement.
POST /dispatch/cancel/{movementId}	Users	Cancels an in-progress or delivered movement, given it is the current movement for the driver.
POST /dispatch/changeEquipment/{movementId}	Users	Handles equipment ID changes for a given movement and specific piece of equipment.
POST /dispatch/clearPreassignments/{movementId}	Users	Clears all preassigned equipment for the given movement.
POST /dispatch/clearStop/{stopId}	Users	Clears the stop with the given dates and creates a service failure record if necessary.
POST /dispatch/locateTractor	Users	Locates a tractor at the provided location.
POST /dispatch/moveTrailer	Users	Moves the trailer to the provided location.
POST /dispatch/reconsign/{movementId}	Users	Reconsigns the order for the given movement.
POST /dispatch/split/{splitBeforeStopId}	Users	Splits the given movement, given the specified stop and equipment information.
POST /dispatch/unsplit/{movementId}	Users	Unsplits the given movement.
POST /dispatch/{stopId}/acceptOffer	Drivers	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	Drivers	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}/beginTrip	Drivers	Handles the changes needed to be made when a driver begins a trip. Currently, this only works for LTL peddle movements since these are the only ones that use begin and end trip stops.
POST /dispatch/{stopId}/complete	Drivers	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	Drivers	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	Drivers	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	Drivers	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}/endTrip	Drivers	Handles the changes needed to be made when a driver ends a trip. Currently, this only works for LTL peddle movements since these are the only ones that use begin and end trip stops.
POST /dispatch/{stopId}/freightPhoto	Drivers	Handles the changes needed to be made when a driver submits a photo of freight. Currently, this only works for LTL movements.
POST /dispatch/{stopId}/scanDocument	Drivers	Handles the changes needed to be made when a driver scans documents. Currently, this only works for LTL movements.
POST /dispatch/{stopId}/start	Drivers	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.