POST api/Driver/SendDriverMessage
Request Information
URI Parameters
None.
Body Parameters
DriverMessageRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanySCAC | string |
None. |
|
| DriverCode | string |
None. |
|
| MessageTitle | string |
None. |
|
| MessageText | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"CompanySCAC": "sample string 1",
"DriverCode": "sample string 2",
"MessageTitle": "sample string 3",
"MessageText": "sample string 4"
}
text/html
Sample:
{"CompanySCAC":"sample string 1","DriverCode":"sample string 2","MessageTitle":"sample string 3","MessageText":"sample string 4"}
application/xml, text/xml
Sample:
<DriverMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BGEAPI.Models.DriverAPIModels"> <CompanySCAC>sample string 1</CompanySCAC> <DriverCode>sample string 2</DriverCode> <MessageText>sample string 4</MessageText> <MessageTitle>sample string 3</MessageTitle> </DriverMessageRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
DriverMessageResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| SentQCMessage | boolean |
None. |
|
| SentTransfloMessage | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"SentQCMessage": true,
"SentTransfloMessage": true
}
text/html
Sample:
{"SentQCMessage":true,"SentTransfloMessage":true}
application/xml, text/xml
Sample:
<DriverMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BGEAPI.Models.DriverAPIModels"> <SentQCMessage>true</SentQCMessage> <SentTransfloMessage>true</SentTransfloMessage> </DriverMessageResponse>