go back to CarrierDriverMessageService

GET /carrierDriverMessages/previewMessage

Retrieves the composed message.

Roles that can access this endpoint are Users.

Parameters

name description type default type
orderId ID of the order that the driver was assigned query String
movementId ID of the movement that the driver was assigned query String
includeStopNameAddress whether to include the name and address of all stops query false Boolean
includeArrivalTimes whether to include scheduled arrival times query false Boolean
includeContactInformation whether to include contact information query false Boolean
includeComments whether to include dispatch and hot comments query false Boolean
includeReferenceNumbers whether to include BOL and reference numbers query false Boolean
includeDirections whether to include location directions query false Boolean
includeDirectionsDisclaimer whether to include directions disclaimer query false Boolean
includeDistanceBetweenStops whether to include distance between each stop query false Boolean
includeSendersOfficeNumber whether to include the office phone number of the user sending the message query false Boolean
includeSendersCellNumber whether to include the cell number of the user sending the message query false Boolean
includeSendersEmail whether to include the email address of the user sending the message query false Boolean
includeDoNotCallNotice whether to include Do Not Call notice query false Boolean
freeformText query String

Result

String of type: text/plain

a String message

Try It Out

Request

- Authentication Help
- String
- String
- Boolean
- Boolean
- Boolean
- Boolean
- Boolean
- Boolean
- Boolean
- Boolean
- Boolean
- Boolean
- Boolean
- Boolean
- String