FleetCustomerAPI


Click here for a complete list of operations.

sendPushNotification

Send PushNotification to the registered smartPhone
APP_NAME - Required
userName - Required - login verification
password - Required - login verification
driverName - Required - the user to send the notification to - this must be a driver from the same account as the user who logged in - If no value is entered it defaults to the user login (userName)
alertMessage - Required - contains the text message that should be displayed to the user
messageFormat - Optional - This will be '0' for alert or '1' for reminder - If no value is entered it defaults to '0'
vehicle - Optional - contain the vehicle name
deviceId - Optional - contains the serial number of the device installed in the vehicle that initiated the alert
latitude - Optional - contains the latitude of where the incident that raised the alert occurred
longitude - Optional - contains the longitude of where the incident that raised the alert occurred
When the user submits a request through this webservice it should send a push notification to the registered device of the 'driverName'

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
APP_NAME:
userName:
password:
driverName:
alertMessage:
messageFormat:
vehicle:
deviceId:
latitude:
longitude:

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 /Services/FleetCustomerAPI.asmx HTTP/1.1
Host: api.fleetlocate.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://services.aWareLive.com/sendPushNotification"

<?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>
    <sendPushNotification xmlns="http://services.aWareLive.com/">
      <APP_NAME>string</APP_NAME>
      <userName>string</userName>
      <password>string</password>
      <driverName>string</driverName>
      <alertMessage>string</alertMessage>
      <messageFormat>string</messageFormat>
      <vehicle>string</vehicle>
      <deviceId>string</deviceId>
      <latitude>string</latitude>
      <longitude>string</longitude>
    </sendPushNotification>
  </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>
    <sendPushNotificationResponse xmlns="http://services.aWareLive.com/">
      <sendPushNotificationResult>
        <result>
          <code>string</code>
          <msg>string</msg>
        </result>
      </sendPushNotificationResult>
    </sendPushNotificationResponse>
  </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 /Services/FleetCustomerAPI.asmx HTTP/1.1
Host: api.fleetlocate.com.au
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>
    <sendPushNotification xmlns="http://services.aWareLive.com/">
      <APP_NAME>string</APP_NAME>
      <userName>string</userName>
      <password>string</password>
      <driverName>string</driverName>
      <alertMessage>string</alertMessage>
      <messageFormat>string</messageFormat>
      <vehicle>string</vehicle>
      <deviceId>string</deviceId>
      <latitude>string</latitude>
      <longitude>string</longitude>
    </sendPushNotification>
  </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>
    <sendPushNotificationResponse xmlns="http://services.aWareLive.com/">
      <sendPushNotificationResult>
        <result>
          <code>string</code>
          <msg>string</msg>
        </result>
      </sendPushNotificationResult>
    </sendPushNotificationResponse>
  </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 /Services/FleetCustomerAPI.asmx/sendPushNotification?APP_NAME=string&userName=string&password=string&driverName=string&alertMessage=string&messageFormat=string&vehicle=string&deviceId=string&latitude=string&longitude=string HTTP/1.1
Host: api.fleetlocate.com.au

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

<?xml version="1.0" encoding="utf-8"?>
<reponse xmlns="http://services.aWareLive.com/">
  <result>
    <code>string</code>
    <msg>string</msg>
  </result>
</reponse>

HTTP POST

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

POST /Services/FleetCustomerAPI.asmx/sendPushNotification HTTP/1.1
Host: api.fleetlocate.com.au
Content-Type: application/x-www-form-urlencoded
Content-Length: length

APP_NAME=string&userName=string&password=string&driverName=string&alertMessage=string&messageFormat=string&vehicle=string&deviceId=string&latitude=string&longitude=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<reponse xmlns="http://services.aWareLive.com/">
  <result>
    <code>string</code>
    <msg>string</msg>
  </result>
</reponse>