Shared Complex Types

Last updated
Save as PDF

Transaction Block

The transaction block element serves as the root element for the returned XML document containing one or more de-queued transactions. The transaction block element takes the following form:

As illustrated, the tranBlock element contains a sequence of one or more transaction (<tran>) elements. The <tran> element can contain an element of any type. This is a polymorphic construct which allows the <tran> element to contain any existing or future transaction type element while providing a level of forward compatibility for older schema versions.

As described, the <tran> element will consist of one of the possible transaction types supported by the Services Portal. In addition, the <tran> element has several attributes including:

ID = Indicates the unique identifier (number) associated with the transaction contained in the <tran> element.
companyID = The Services Portal company identifier of the company that published the transaction. This attribute may be used to identify the source of the published transaction if it differs from the company that's dequeueing (receiving) the transaction.
auxID = The Omnitracs-assigned auxiliary customer account identifer of this transaction's publishing company. This attribute may be used to identify the source of the published transaction if it differs from the company that's dequeueing (receiving) the transaction.

The following XML fragment illustrates a <tranBlock> element containing mutiple <tran> elements, in this case, multiple transactions of differing transaction types (e.g. <T.2.06.0> and <T.1.01.0>).

<tranBlock>
   <tran ID="16012" companyID="MYCOMPANY" auxID="0999999999">
      <T.2.06.0>
              :
         Transaction-type specific elements
              :
      </T.2.06.0>
   </tran>
  <tran ID="16013" companyID="MYCOMPANY" auxID="0999999999">
      <T.1.01.0>
              :
         Transaction-type specific elements
              :
      </T.1.01.0>
   </tran>
        :
</tranBlock>

Many of the XML elements contained in the transactions are simple elements which have no attributes, and are used to contain data represented using the string data type. However, the following global elements are re-used in several transaction types and contain one or more attributes.

Equipment Element

Uniquely defines a piece of equipment and its type and takes the following form:

(info) At this time, only the GeoServices Event Notification Transaction will be published with optional division attribute.

The following XML fragment illustrates this structure:


<equipment ID="T8199" SCAC="TEST" equipType="trailer" unitAddress="0123456789" mobileType="10" foreign="N"/>

Prior Equipment Element

Defines a piece of equipment's prior definition and takes the following form which is virtually identical to the equipment element:

The following XML fragment illustrates this structure:

<priorEquipment ID="T00123" SCAC="QUALC" unitAddress="122300303" equipType="trailer"/>

Position Element

Geographical coordinates at a point in time, taking the following form:

The following XML fragment illustrates this structure:

<position lat="41.055833333" lon="-92.4525" posTS="2006-07-27T20:41:26Z"/>

Proximity Element

Location information expressed as a reference to a nearby place, and taking the following form:

(info) At this time, only the GeoServices Event Notification Transaction will be published with optional placeAlias attributes.

The following XML fragment illustrates this structure:

<proximity city="Sea Cliff" postal="11579" country="US" distance="1.36" direction="E" placeType="TOWN" stateProv="NY"/>

Note: In transactions where a proximity element is specified, it is always specified as optional, and specifies that you can get zero or many instances. If a proximity to a large city can be derived, it will be supplied. If a proximity to a small town can be derived, it will be supplied. If either cannot be computed, either may be omitted.

Electronic Control Unit (ECU) Device Element

Electronic control unit identification information typically used to identify an on-board device being monitored or reporting event information such as fault activity, taking the following form:

Onboard Data Element

A data point represented as a name/value pair with unit of measure information, collected by a vehicle's onboard sensors or devices.

J1587 Fault Event Element

An on-board fault reporting event based on the SAE J1587 standard, taking the following form:

J1939 Fault Event Element

An on-board fault reporting event based on the SAE J1939 standard, taking the following form:

Reefer Temperature Control Zone

An element describing the operational status and various temperature settings for a specific refrigerated trailer's temperature control zone.