Skip to main content
Omnitracs Knowledge Base

T.2.RM01.0 to T.2.RM63.0

T.2.RM01.0 to T.2.RM63.0 - Return Macro Messages

All return macro message share a common schema, although each transaction is identified with a unique transaction type.

The following diagram describes the T.2.RM01.0 macro type for illustrative purposes.  There are several Shared Complex Types which are re-used within most of the Services Portal (SP) transactions.



The Macro Body Element


Each of the return macro transactions contains a single macro body element (macroBody). The macroBody element, in turn, contains a sequence of elements consisting of a macroType element and zero or more macroField elements and/or fieldGroup elements.

The macroBody elements take the following form:


Macro field groupings are explicitly conveyed via a dedicated grouping element called <fieldGroup>. Each <fieldGroup> element has a "dictTag" attribute whose value describes the name/ nature of the field grouping. Field groups with identical dictionary tag attribute values may be repeated within a given macro. Such identical groups are only distinguished by the data contained within their <macroField> elements. For example, if a macro contained two field groups defining stop information, then each stop group could be distinguished by the inclusion of a "stopNumber" macro field within each group. It is the responsibility of the person designing the macro template to include such differentiating information (if needed) in the event of repeating macro groups.


Macro Body Sample


Consider a hypothetical "load assignment" macro taking the following form:

 LOAD# _________  TRAILER# ________

 SHIPPER NAME: ____________________

 LOCATION: ________________________


 CONSIGNEE NAME: __________________

 LOCATION: ________________________


 COMMENTS: _______________________

The following example illustrates the XML format of the entire transaction, including the <macroBody> element for a hypothetical forward macro. Note: Example is for illustrative purposes, only return macros will be supported initially. Please note that the macro body is just an example. The macro definition will define how the macro body XML will be structured.

<tran ID="39245">



      <equipment ID="1111111111" SCAC="ABCD" equipType="tractor"/>

      <equipment ID="2222222222" SCAC="ABCD" equipType="trailer"/>

      <equipment ID="3333333333" SCAC="ABCD" equipType="trailer"/>

      <equipment ID="4444444444" SCAC="ABCD" equipType="trailer"/>


      <position lat="32.895000000" lon="-117.194722222" posTS="2006-05-17T15:20:38Z"/>

      <proximity city="San Diego" postal="92073" country="US" distance="10.89" direction="NNW" placeType="CITY" stateProv="CA"/><proximity city="La Jolla" postal="92037" country="US" distance="5.50" direction="NE" placeType="TOWN" stateProv="CA"/>

      <proximity town="Reading" postal="19601" country="US" distance="12.73" direction="SSE" placeType="CITY" stateProv="PA"/><proximity city="Morgantown" postal="19543" country="US" distance=".55" direction="ENE" placeType="TOWN" stateProv="PA"/>









            <macroType direction="F" number="4" version="1">Load Assignment</macroType>

            <macroField dictTag="loadNumber">001228913</macroField>

            <macroField dictTag="trailerNumber">1212938</macroField>

            <fieldGroup dictTag="Shipper">

               <macroField dictTag="shipperName">Vandalay Industries</macroField>

               <macroField dictTag="location">Industrial Blvd, Brooklyn, NY 11231</macroField>


            <macroField dictTag="additionalPickups">1</macroField>

            <macroField dictTag="drops">0</macroField>

            <fieldGroup dictTag="Consignee">

               <macroField dictTag="consigneeName">Kramerica Industries</macroField>

               <macroField dictTag="location">205 West 86st NY, NY 10019</macroField>


            <macroField dictTag="totalMiles">37.89</macroField>

            <macroField dictTag="comments">Highly combustable load!</macroField>





Note: When no driver is logged in, the <DriverID> filed will not be present. When the <DriverID> field is missing, that indicates no driver was logged in.

  • Was this article helpful?