GET /carrierDriverMessages
Gets all driver text messages matching the request criteria. If no criteria given,
then all driver text messages for the current company are returned.
For example, /carrierDriverMessages?order_id=0256189
would find driver text messages for order 0256189.
Roles that can access this endpoint are Users.
Parameters
| name |
description |
type |
default |
type |
| request |
read for query parameters to be used as search criteria; use any combination
of fields from the carrier_driver_message table |
context
|
|
HttpServletRequest
|
Result
List
<
RowCarrierDriverMessage
>
of type:
application/xml
application/json
a list of RowCarrierDriverMessage objects
Additional attributes:
__statusDescr This value represents the description of the status, found in the carrier_driver_message.status field.__directionDescr This value represents the description of the direction, found in the carrier_driver_message.direction field.__vendorDescr This value represents the description of the vendor, found in the carrier_driver_message.vendor_id field.
Child Elements:
RowUsers This element represents the user associated with the driver text message, by the carrier_driver_message.user_id field.
The element contains a __name attribute with the value user.RowDriver This element represents the asset driver user associated with the driver text message, by the carrier_driver_message.asset_driver_id field.
The element contains a __name attribute with the value assetDriver.RowPayee This element represents the carrier user associated with the driver text message, by the carrier_driver_message.carrier_id field.
The element contains a __name attribute with the value carrier.RowCarrierDriver This element represents the carrier driver user associated with the driver text message, by the carrier_driver_message.driver_id field.
The element contains a __name attribute with the value carrierDriver.RowMmsMedia This element represents the media associated with the driver text message.
The element contains a __name attribute with the value mmsMedia.
Try It Out
Request