GET /movements/{id}
Retrieves the Movement specified by the ID.
Roles that can access this endpoint are Users, Drivers, Carriers, Carrier Drivers.
Parameters
name |
description |
type |
default |
type |
id |
ID of the movement to be returned |
path
|
|
String
|
Result
RowMovement
of type:
application/xml
application/json
the requested RowMovement object
Additional attributes:
__statusDescr
This value represents the description of the move status, found in the move.status
field.
__overrideTypeDescr
This value represents the description of the override pay method, found in the move.override_type
field.
__brokerageStatusDescr
This value represents the description of the brokerage status, found in the move.brokerage_status
field.
__freightRevenue
This value represents the calculated freight revenue.
__otherRevenue
This value represents the calculated other revenue.
__totalRevenue
This value represents the calculated total revenue.
__otherPay
This value represents the calculated other pay.
__totalPay
This value represents the calculated total pay.
__profit
This value represents the calculated profit.
__profitPercentage
This value represents the calculated profit percentage.
__tractor_id
This value represents the assigned tractor ID.
__driver%_id
This value represents the assigned driver ID, where % is the driver number (driver1_id, driver2_id).
__trailer%_id
This value represents the assigned trailer ID, where % is the trailer number (trailer1_id, etc).
Child Elements:
RowTractor
This element represent the tractor associated with the movement.
The element contains a __name
attribute with the value tractor
.
RowDriver
These element represent the drivers associated with the movement.
The element contains a __name
attribute with the value driver%
, where % is the driver number (driver1, driver2).
RowTrailer
These element represent the trailers associated with the movement.
The element contains a __name
attribute with the value trailer%
, where % is the trailer number (trailer1, trailer2, etc).
RowUsers
This element represent the dispatcher associated with the movement, by the movement.dispatcher_user_id
field.
The element contains a __name
attribute with the value dispatcherUser
.
RowUsers
This element represent the operations user associated with the movement, by the movement.operations_user
field.
The element contains a __name
attribute with the value operationsUser
.
RowUsers
This element represent the fleet manager user associated with the movement, by the movement.fleet_manager
field.
The element contains a __name
attribute with the value fleetManagerUser
.
RowPayee
This element represent the carriers user associated with the movement, by the movement.override_payee_id
field.
The element contains a __name
attribute with the value carrier
.
RowStop
These elements represent the stops associated with the movement.
Each element contains a __name
attribute with the value stops
.
RowOrders
These elements represent the orders associated with the movement.
Each element contains a __name
attribute with the value orders
.
RowMcUnit
This element represents the mc_unit associated with the tractor or driver on the movement.
The element contains a __name
attribute with the value mc_unit
.
Try It Out
Request