WS_Android Web Service

WS_Android

Click here for a complete list of operations.

WS_MESSAGESRECEIVED

Notifies TRUX that the message has been received by the device.

an array of the messages received by the device company code success

Test

The test form is only available for requests from the local machine.

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_MESSAGESRECEIVED"

<?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_MESSAGESRECEIVED xmlns="http://www.trux.com">
      <messages>
        <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>
      </messages>
      <companyCode>string</companyCode>
    </WS_MESSAGESRECEIVED>
  </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_MESSAGESRECEIVEDResponse xmlns="http://www.trux.com">
      <WS_MESSAGESRECEIVEDResult>boolean</WS_MESSAGESRECEIVEDResult>
    </WS_MESSAGESRECEIVEDResponse>
  </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_MESSAGESRECEIVED xmlns="http://www.trux.com">
      <messages>
        <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>
      </messages>
      <companyCode>string</companyCode>
    </WS_MESSAGESRECEIVED>
  </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_MESSAGESRECEIVEDResponse xmlns="http://www.trux.com">
      <WS_MESSAGESRECEIVEDResult>boolean</WS_MESSAGESRECEIVEDResult>
    </WS_MESSAGESRECEIVEDResponse>
  </soap12:Body>
</soap12:Envelope>