WS_Android Web Service

WS_Android

Click here for a complete list of operations.

WS_GETDIRECTMESSAGES

Gets direct messages based on the criteria provided.

driver number truck number route date [yyyy-MM-dd] route number list of message ids that exist on the device company code a list of messages based on the criteria provedied

Test

The test form is only available for methods with primitive types as parameters.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /TruxWeb/WSRout_Android/WS_Android.asmx HTTP/1.1
Host: trux.organicdiversion.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.trux.com/WS_GETDIRECTMESSAGES"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <Credentials xmlns="http://www.trux.com">
      <sAccountID>string</sAccountID>
      <sAuthCode>string</sAuthCode>
      <isAuthCodeEncrypted>boolean</isAuthCodeEncrypted>
      <areParametersEncrypted>boolean</areParametersEncrypted>
      <encryptedParameterNames>
        <string>string</string>
        <string>string</string>
      </encryptedParameterNames>
      <requireEncryptedResponse>boolean</requireEncryptedResponse>
      <encryptionMethod>string</encryptionMethod>
      <keyInfo>
        <encryptedKey>string</encryptedKey>
        <encryptionPublicKey>string</encryptionPublicKey>
      </keyInfo>
      <publicAuthKey>string</publicAuthKey>
    </Credentials>
  </soap:Header>
  <soap:Body>
    <WS_GETDIRECTMESSAGES xmlns="http://www.trux.com">
      <driver>string</driver>
      <truck>string</truck>
      <routeDate>string</routeDate>
      <route>string</route>
      <excludedIDs>
        <string>string</string>
        <string>string</string>
      </excludedIDs>
      <companyCode>string</companyCode>
    </WS_GETDIRECTMESSAGES>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <WS_GETDIRECTMESSAGESResponse xmlns="http://www.trux.com">
      <WS_GETDIRECTMESSAGESResult>
        <directMessage>
          <Truck>int</Truck>
          <Driver>int</Driver>
          <Route>int</Route>
          <TimeStamp>dateTime</TimeStamp>
          <Sender>string</Sender>
          <RequireConfirm>int</RequireConfirm>
          <ID>int</ID>
          <Message>string</Message>
          <ReceiveTime>dateTime</ReceiveTime>
          <ConfirmDate>dateTime</ConfirmDate>
          <DeviceID>string</DeviceID>
          <HasDriverSeenMessage>int</HasDriverSeenMessage>
          <HasDriverReadMessage>int</HasDriverReadMessage>
          <RecipientID>int</RecipientID>
          <ReceivingDriver>int</ReceivingDriver>
        </directMessage>
        <directMessage>
          <Truck>int</Truck>
          <Driver>int</Driver>
          <Route>int</Route>
          <TimeStamp>dateTime</TimeStamp>
          <Sender>string</Sender>
          <RequireConfirm>int</RequireConfirm>
          <ID>int</ID>
          <Message>string</Message>
          <ReceiveTime>dateTime</ReceiveTime>
          <ConfirmDate>dateTime</ConfirmDate>
          <DeviceID>string</DeviceID>
          <HasDriverSeenMessage>int</HasDriverSeenMessage>
          <HasDriverReadMessage>int</HasDriverReadMessage>
          <RecipientID>int</RecipientID>
          <ReceivingDriver>int</ReceivingDriver>
        </directMessage>
      </WS_GETDIRECTMESSAGESResult>
    </WS_GETDIRECTMESSAGESResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /TruxWeb/WSRout_Android/WS_Android.asmx HTTP/1.1
Host: trux.organicdiversion.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <Credentials xmlns="http://www.trux.com">
      <sAccountID>string</sAccountID>
      <sAuthCode>string</sAuthCode>
      <isAuthCodeEncrypted>boolean</isAuthCodeEncrypted>
      <areParametersEncrypted>boolean</areParametersEncrypted>
      <encryptedParameterNames>
        <string>string</string>
        <string>string</string>
      </encryptedParameterNames>
      <requireEncryptedResponse>boolean</requireEncryptedResponse>
      <encryptionMethod>string</encryptionMethod>
      <keyInfo>
        <encryptedKey>string</encryptedKey>
        <encryptionPublicKey>string</encryptionPublicKey>
      </keyInfo>
      <publicAuthKey>string</publicAuthKey>
    </Credentials>
  </soap12:Header>
  <soap12:Body>
    <WS_GETDIRECTMESSAGES xmlns="http://www.trux.com">
      <driver>string</driver>
      <truck>string</truck>
      <routeDate>string</routeDate>
      <route>string</route>
      <excludedIDs>
        <string>string</string>
        <string>string</string>
      </excludedIDs>
      <companyCode>string</companyCode>
    </WS_GETDIRECTMESSAGES>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <WS_GETDIRECTMESSAGESResponse xmlns="http://www.trux.com">
      <WS_GETDIRECTMESSAGESResult>
        <directMessage>
          <Truck>int</Truck>
          <Driver>int</Driver>
          <Route>int</Route>
          <TimeStamp>dateTime</TimeStamp>
          <Sender>string</Sender>
          <RequireConfirm>int</RequireConfirm>
          <ID>int</ID>
          <Message>string</Message>
          <ReceiveTime>dateTime</ReceiveTime>
          <ConfirmDate>dateTime</ConfirmDate>
          <DeviceID>string</DeviceID>
          <HasDriverSeenMessage>int</HasDriverSeenMessage>
          <HasDriverReadMessage>int</HasDriverReadMessage>
          <RecipientID>int</RecipientID>
          <ReceivingDriver>int</ReceivingDriver>
        </directMessage>
        <directMessage>
          <Truck>int</Truck>
          <Driver>int</Driver>
          <Route>int</Route>
          <TimeStamp>dateTime</TimeStamp>
          <Sender>string</Sender>
          <RequireConfirm>int</RequireConfirm>
          <ID>int</ID>
          <Message>string</Message>
          <ReceiveTime>dateTime</ReceiveTime>
          <ConfirmDate>dateTime</ConfirmDate>
          <DeviceID>string</DeviceID>
          <HasDriverSeenMessage>int</HasDriverSeenMessage>
          <HasDriverReadMessage>int</HasDriverReadMessage>
          <RecipientID>int</RecipientID>
          <ReceivingDriver>int</ReceivingDriver>
        </directMessage>
      </WS_GETDIRECTMESSAGESResult>
    </WS_GETDIRECTMESSAGESResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /TruxWeb/WSRout_Android/WS_Android.asmx/WS_GETDIRECTMESSAGES?driver=string&truck=string&routeDate=string&route=string&excludedIDs=string&excludedIDs=string&companyCode=string HTTP/1.1
Host: trux.organicdiversion.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfDirectMessage xmlns="http://www.trux.com">
  <directMessage>
    <Truck>int</Truck>
    <Driver>int</Driver>
    <Route>int</Route>
    <TimeStamp>dateTime</TimeStamp>
    <Sender>string</Sender>
    <RequireConfirm>int</RequireConfirm>
    <ID>int</ID>
    <Message>string</Message>
    <ReceiveTime>dateTime</ReceiveTime>
    <ConfirmDate>dateTime</ConfirmDate>
    <DeviceID>string</DeviceID>
    <HasDriverSeenMessage>int</HasDriverSeenMessage>
    <HasDriverReadMessage>int</HasDriverReadMessage>
    <RecipientID>int</RecipientID>
    <ReceivingDriver>int</ReceivingDriver>
  </directMessage>
  <directMessage>
    <Truck>int</Truck>
    <Driver>int</Driver>
    <Route>int</Route>
    <TimeStamp>dateTime</TimeStamp>
    <Sender>string</Sender>
    <RequireConfirm>int</RequireConfirm>
    <ID>int</ID>
    <Message>string</Message>
    <ReceiveTime>dateTime</ReceiveTime>
    <ConfirmDate>dateTime</ConfirmDate>
    <DeviceID>string</DeviceID>
    <HasDriverSeenMessage>int</HasDriverSeenMessage>
    <HasDriverReadMessage>int</HasDriverReadMessage>
    <RecipientID>int</RecipientID>
    <ReceivingDriver>int</ReceivingDriver>
  </directMessage>
</ArrayOfDirectMessage>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /TruxWeb/WSRout_Android/WS_Android.asmx/WS_GETDIRECTMESSAGES HTTP/1.1
Host: trux.organicdiversion.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

driver=string&truck=string&routeDate=string&route=string&excludedIDs=string&excludedIDs=string&companyCode=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfDirectMessage xmlns="http://www.trux.com">
  <directMessage>
    <Truck>int</Truck>
    <Driver>int</Driver>
    <Route>int</Route>
    <TimeStamp>dateTime</TimeStamp>
    <Sender>string</Sender>
    <RequireConfirm>int</RequireConfirm>
    <ID>int</ID>
    <Message>string</Message>
    <ReceiveTime>dateTime</ReceiveTime>
    <ConfirmDate>dateTime</ConfirmDate>
    <DeviceID>string</DeviceID>
    <HasDriverSeenMessage>int</HasDriverSeenMessage>
    <HasDriverReadMessage>int</HasDriverReadMessage>
    <RecipientID>int</RecipientID>
    <ReceivingDriver>int</ReceivingDriver>
  </directMessage>
  <directMessage>
    <Truck>int</Truck>
    <Driver>int</Driver>
    <Route>int</Route>
    <TimeStamp>dateTime</TimeStamp>
    <Sender>string</Sender>
    <RequireConfirm>int</RequireConfirm>
    <ID>int</ID>
    <Message>string</Message>
    <ReceiveTime>dateTime</ReceiveTime>
    <ConfirmDate>dateTime</ConfirmDate>
    <DeviceID>string</DeviceID>
    <HasDriverSeenMessage>int</HasDriverSeenMessage>
    <HasDriverReadMessage>int</HasDriverReadMessage>
    <RecipientID>int</RecipientID>
    <ReceivingDriver>int</ReceivingDriver>
  </directMessage>
</ArrayOfDirectMessage>