MovementService

This service provides methods for retrieving movements, flipping them between brokerage and asset types, sending load confirmations and managing extra pay on the movement.

Operations

name	role	description
GET /movements	Users	Retrieves a List of movements having a full or partial match of the ID to the given argument.
GET /movements/adhocOffers	Drivers	Retrieves a List of RowMovement objects matching the criteria given that represent the available movements for a driver.
GET /movements/customTemplates	Users	Retrieves a list of custom document designer templates. Used in conjunction with sending rate confirmations.
GET /movements/offers	Drivers	Retrieves a List of RowMovement objects that represent the top five available movements for a driver.
GET /movements/retrieve	Freight Matching	Searches the database for movements matching the given request parameters. Query parameters to be used as search criteria; All parameters are optional.
GET /movements/search	Users	Searches the database for movements matching the given request parameters.
GET /movements/userSavedSearch	Users	Retrieves a List of RowMovement objects based on an existing saved search.
GET /movements/{id}	Users, Drivers, Carriers, Carrier Drivers	Retrieves the Movement specified by the ID.
GET /movements/{id}/confirmationDefaults	Users	Retrieves the default values for the carrier contact to receive the rate confirmation.
GET /movements/{id}/estimatedPay	Drivers	Retrieves the estimated pay for the load specified by the ID..
GET /movements/{id}/otherPay	Users	Returns a list of Driver Extra Pay records for a given movement
GET /movements/{id}/otherPay/{otherPayId}	Users	Returns the requested driver extra pay record.
GET /movements/{id}/route	Users, Drivers, Carriers	Retrieves the step by step route information from the connected mileage software. Based on EntryMovement.showRoute();
POST /movements/createLTLMovement	Users	Creates an LTL movement. If a recurringMovementId is given, then the movement will be created from that record and all other parameters on this request will serve to override it. When this parameter is omitted, the movement type, origin, destination, departure date and transit basis are used to find a recurring movement that best matches those values. Again, all other parameters would override those values. If no recurring movement is specified or found, a new blank movement is created with the parameters from this method filling in the details.
POST /movements/{id}/acceptOffer	Drivers	Accepts the movement and preassigns the driver to it, depending on the dispatch control setting.
POST /movements/{id}/declineOffer	Drivers	Declines the movement offered to the driver.
POST /movements/{id}/setBrokerageFlag	Users
POST /movements/{id}/updateLocationTrackingStatus	Carriers, Carrier Drivers	Updates the Brokerage Tracking Status based on if the user's device has location services enabled
POST /movements/{id}/updateOperationalStatus	Users	Updates the operational status field on the movement. Movements must be of LTL type.
PUT /movements/{id}/otherPay	Users	Creates other pay records tied to the movement record.
PUT /movements/{id}/sendConfirmation	Users	Sends a confirmation to the carrier, via return PDF, email, fax, or eRate (imaging).