Send

The send endpoint can be use to submit Omnitracs workflow messages to Cyan.

Message format:

WSDL

Responses:

The send operation will return a send response object that describes the result of the operation.  A send response object has two properties:

  1. message: Text describing the result of the operation.
  2. status: 1 or 0
    1. 1 = success
    2. 0 = failure

Calling applications are responsible for checking the status property to determine the result of the operation.  

  1. Successful trip insert.
  2. Failed trip insert.
  3. Successful trip clear.
  4. Failed trip clear 

Exceptions:

All exceptions encountered during the processing of the send operation will be returned to the caller in the for of a soap fault.  Exceptions are most commonly caused by missing or invalid data passed in body of the send message.

Below are some examples are some examples of possible soap exceptions that could be returned by the send operation: (This list is not all inclusive and other faults are possible.)

  1. Invalid soap message body sent to the send operation
  2. Invalid message type sent to send operation.
  3. Missing driver data in send message.
  4. Missing required data in send message.

Have questions? Email support@bluedotsolutions.com