Common Type Definitions

Id

IdType

Contains the unique keys for this message for both customer and platform

Yes

AckStatus

AckStatusType (int)

1 to acknowledge the message the message as read and 0 to not acknowledge the message (puts it in an Failed state)

Yes

AckStatusReason

string

Customer defined area to add more detail to ack/nack

No

Type

ResourceType (string) 

A selection for the type of Resource (AOI, Device, Driver, Vehicle, Customer, User, Configuration, Data) [Suggested Value: Vehicle]

Yes

CustomerAssignedId

string

Identifier assigned by the customer (For a Vehicle for example it would be the Vehicle ID)

No

Routing

RoutingType

Contains the information about how the message was routed

Yes

Configuration

ConfigurationResourceType

Container for actual payload in the message

No

Status

ConfigurationStatusType

Message creation time 

Yes

Resources

AssociatedResourceType

Any additional information about the creation and changes to the message

No

MetaData

NameValueType

Any additional information about the creation and changes to the message

No

UOMType

string

Indicates the UOM in use for Speed and Odometer. Currently should be set to 'Omnitracs' which indicates Speed is in MPH, Odometer is in Miles and Latitude, Longitude is in Degrees.

No

Valid

boolean

Indicates if position data is valid or not

Yes

TransmitOrCreate

string

Indicates if the position is from when the message was created or transmitted. Will have values: Create or Transmit.

No

Ignition

string

State of Ignition: On, Off or Unknown

No

Speed

unsignedByte 

Speed if known

No

Direction

float

The Direction Heading, in degrees.

No

PosFixTime

dateTime

The time at which the position was obtained.

Yes

Odometer

float

The Odometer value if known.

No

Latitude

float

Latitude reading

Yes

Longitude

float

Longitude reading

Yes

Delivery

DistributionDeliveryType(string)

What type of delivery mechanism was used: Jms, Email, Ftp, Dequeue, Inforouter, Other

Yes

State

DistributionStateType  (string)

State of delivery from the endpoint perspective: Sent, Received, Pending, Processed, Failed, unknown

Yes

Key

string

Unique key for platform message, Usually represented as a GUID e.g. 6db542fc-ff6c-46f2-899e-644700ef1d37 

Yes

Id

string

Id field, varies based on Application

Yes

Key

string

Unique transactional identifier

Yes

AckStatus

AckStatusType (int)

Nack/Ack status from the various sub-systems 0 = nack, 1 = ack

No

AckStatusReason

string

Some text explaining the reason for a Nack

No

Date

Datetime

Date and time when change happened

Yes

Who

String

Identifier of who sent the Ack/Nack. Should be either 'network' or 'mobile'.

Yes

AckContext

ContextType

Position Information detailing when the Ack/Nack was sent

No

Audit

IncomingAuditType

List of audit actions

Yes

Key

string

Unique transactional identifier

Yes

Distribution

DistributionType

Status on the delivery states

No

Date

dateTime

Date and time when change happened

Yes

Who

string

Identifier

Yes

Audit

OutgoingAuditType

List of audit actions

Yes

Unread

Used to select messages that are waiting to be retrieved by the customer, that have not yet been read.  This is the normal use case for retrieving new messages. Once a customer retrieves the messages, they can acknowledge that they have been 'Read' in one of two ways. The first is to specify autoAck=true in the read request. The second is to pass the individual acknowledgements in a subsequent call. The first method will always mark the messages as read successfully (ACKED) and the second allows the allows the caller to mark them either as read successfully (ACKED) or unsuccessfully (NACKED). Messages in an ACKED or NACKED state are both interpreted to have been 'Read' by the customer.

Read

Used to select previously 'Read' messages. This can be useful along with a date range to retrieve previously read messages. The messages can then be ACKED or NACKED using the same methods as used for retrieving the Read messages.

Delivered

This read state can be used to retrieve messages that were previously delivered via a push mechanism to the customer. Along with available filter parameters, this can be useful to retrieve messages which need to be re-processed. This state is only supported in version 1.1 or later.

Failed

This read state can be used to retrieve messages that were unable to be delivered to the customer. The system has a fairly robust retry mechanism that will periodically attempt to retry delivery of the messages. Using this state will allow the customer to retrieve these messages directly via a web service call, even if the retry eventually expires.

ContentType

string

Mime Type of the Payload (e.g. image/jpeg)

No

Filename

string

Filename of the encoded payload. Only if original payload was a file.

No

Type

string

Whether the payload is of type 'Text' or 'Binary' [Suggested Value: Binary]

Yes

Binary

hexBinary

If Type='Binary', the payload will be in this field. Data for mobile. Instructions on how to encode and decode binary data

No

Text

string

If Type='Text', the payload will be in this field.

No

Priority

PriorityType

Denotes the level of priority (High = 5, Medium = 3, Low = 0) used in the delivery of the message. If provided, only messages of the given priority are returned.

No

Source

BaseResourceType

Reference who sent the message (typically this would be Vehicle)

No

Service

ServiceType

Qualifies what service (typically an application) handled this message in the platform

Yes

Primary

IdentityType

Typically denotes Application's Identity (Id and Description)

Yes