Trailer Information

Last updated
Save as PDF

Information about a trailer is implemented in the Trailer object. The attributes of the Trailer object are:

Attribute	Description
type	A string of maximum length 3 that indicates the type of the trailer (e.g. DRY, FLT, VAN, 48F, 53F).
posTime	A string containing a timestamp in the form YYYY-MM-DDTHH:MM:SSZ indicating the time in GMT of the last position report from this trailer.
latitude	A floating point (double) value containing the last reported latitude of the trailer in decimal degrees. A positive value indicates the northern hemisphere. A negative value indicates the southern hemisphere.
longitude	A floating point (double) value containing the last reported longitude of the trailer in decimal degrees. A positive value indicates the eastern hemisphere. A negative value indicates the western hemisphere.
proximityTown	A ProximityReference object containing information about the small town that is nearest to the last reported position of this trailer.
proximityCity	A ProximityReference object containing information about the large city that is nearest to the last reported position of this trailer.
vehicle	An AssetIdentifier containing the Standard Carrier Alpha Code (SCAC) and identifier for the vehicle currently connected to this trailer.
lost	A string indicating whether or not this trailer status is overdue. A trailer's status is considered overdue when no trailer reports (positions or events) have been received within a specified period of time. This period of time is set as a number of days in the trailer's monitoring plan. Possible values are: Y The trailer's status is overdue N The trailer's status is not overdue
eventDesc	A string containing a description of the event on the trailer.
eventTime	A string containing a timestamp in the form YYYY-MM-DDTHH:MM:SSZ indicating the time in GMT of the event on the trailer.
trlrMonPlan	A Trailer Monitoring Plan object containing information about the trailer's monitoring plan. Every trailer is assigned a monitoring plan. A monitoring plan specifies which trailer events should be monitored and who should be notified when the event is detected. In addition, a monitoring plan also specifies the trailer compatiblity requirement for each sensor (cargo, door, auxiliary). Compatiblity requirements are specified as: Required Preferred Not Used
battCharge	A string indicating the status of the battery on the untehtered trailer tracking unit. Possible values are: 1 Charged 2 Need Charged 3 Need Charged; Needs Replaced 4 Charged; Needs Replaced
battReplace	A string containing a timestamp in the form YYYY-MM-DDTHH:MM:SSZ indicating the time the battery was last replaced on the untehtered trailer tracking unit.
foreignTrlr	A string indicating whether or not this trailer is a foreign or owned trailer. A foreign trailer is one that belongs to another account. Y The trailer is foreign N The trailer is not foreign
loaded	Indicates the loaded status of the trailer. The loaded status may be set by either the state of the cargo sensor or via a call to the SetLoadedStatus web service (but not both). Possible values are: U Unknown L Loaded E Empty
loadTime	A string containing a timestamp in the form YYYY-MM-DDTHH:MM:SSZ indicating the time in GMT of the change to the loaded status.
cargoSnsr	A string indicating the state of the cargo sensor. Possible values are: 0 Sensor not installed 1 Empty 2 Loaded 3 Not enabled U Unknown
cargoSnsrTime	A string containing a timestamp in the form YYYY-MM-DDTHH:MM:SSZ indicating the time in GMT of the change to the state of the cargo sensor.
doorSnsr	A string indicating the state of the door sensor. Possible values are: 0 Sensor not installed 1 Open 2 Closed 3 Not enabled U Unknown
doorSnsrTime	A string containing a timestamp in the form YYYY-MM-DDTHH:MM:SSZ indicating the time in GMT of the change to the state of the door sensor.
auxSnsr	A string indicating the state of the auxiliary sensor. Possible values are: 0 Sensor not installed 1 "Open" 2 "Closed" 3 Not enabled U Unknown
auxSnsrTime	A string containing a timestamp in the form YYYY-MM-DDTHH:MM:SSZ indicating the time in GMT of the change to the state of the auxiliary sensor.
geofence	A Geofence object containing information about this trailer's geofence.
geoText	A string containing a description of the geofeonce.
insideGeo	A string indicating whether or not this trailer is inside its geofence. Possible values are: Y The trailer is inside its geofence N The trailer is not inside its geofence
geoExists	A string indicating whether or not a geofence exists for this trailer. Possible values are: Y A geofence exists for this trailer N No geofence exists for this trailer
geoPndSelfCent	A string indicating whether or not the centerpoint of self-centered geofence is pending (center location unknown). A self-centered geofence uses the trailer's position as of the geofence start date as its centerpoint. Possible values are: 0 Not self-center pending (center location known) 1 Self-center pending (center location unknown)
newGeoSent	Indicates whether or not an updated geofence is being sent to the trailer. Possible values are: Y A new geofence has been sent and is pending N No new geofence has been sent

WSDL Definition

Here is how the Trailer Information object is defined within the WSDL

<complexType name="Trailer">

<sequence>

<element name="type" nillable="true" type="xsd:string"/>

<element name="posTime" nillable="true" type="xsd:string"/>

<element name="latitude" type="xsd:double"/>

<element name="longitude" type="xsd:double"/>

<element name="proximityCity" nillable="true" type="tns2:ProximityReference"/>

<element name="proximityTown" nillable="true" type="tns2:ProximityReference"/>

<element name="vehicle" nillable="true" type="tns2:AssetIdentifier"/>

<element name="lost" nillable="true" type="xsd:string"/>

<element name="eventDesc" nillable="true" type="xsd:string"/>

<element name="eventTime" nillable="true" type="xsd:string"/>

<element name="trlrMonPlan" nillable="true" type="tns2:TrailerMonPlan"/>

<element name="battCharge" nillable="true" type="xsd:string"/>

<element name="battReplace" nillable="true" type="xsd:string"/>

<element name="foreignTrlr" nillable="true" type="xsd:string"/>

<element name="loaded" nillable="true" type="xsd:string"/>

<element name="loadTime" nillable="true" type="xsd:string"/>

<element name="cargoSnsr" nillable="true" type="xsd:string"/>

<element name="cargoSnsrTime" nillable="true" type="xsd:string"/>

<element name="doorSnsr" nillable="true" type="xsd:string"/>

<element name="doorSnsrTime" nillable="true" type="xsd:string"/>

<element name="auxSnsr" nillable="true" type="xsd:string"/>

<element name="auxSnsrTime" nillable="true" type="xsd:string"/>

<element name="geofence" nillable="true" type="tns2:Geofence"/>

<element name="geoText" nillable="true" type="xsd:string"/>

<element name="insideGeo" nillable="true" type="xsd:string"/>

<element name="geoExists" nillable="true" type="xsd:string"/>

<element name="geoPndSelfCent" nillable="true" type="xsd:string"/>

<element name="newGeoSent" nillable="true" type="xsd:string"/>

</sequence>

</complexType>

Sample XML

Here is some sample XML that shows what the Trailer Information object will look like in XML

<getTrailerInformationReturn>

<type>GW2</type>

<posTime>2006-05-18T22:03:08Z</posTime>

<latitude>27.853055555555557</latitude>

<longitude>-82.80777777777777</longitude>

<proximityCity>

<placeType>CITY</placeType>

<distance>2.27</distance>

<direction>@</direction>

<placeName xsi:nil="true" />

<city>Largo</city>

<state>FL</state>

<country>US</country>

<zip>34640</zip>

</proximityCity>

<proximityTown>

<placeType>TOWN</placeType>

<distance>0.91</distance>

<direction>NW</direction>

<placeName xsi:nil="true" />

<city>Seminole</city>

<state>FL</state>

<country>US</country>

<zip>34642</zip>

</proximityTown>

<vehicle>

<id />

<scac />

</vehicle>

<lost>Y</lost>

<eventDesc>Chg Trlr Monitoring</eventDesc>

<eventTime>2006-07-27T18:35:57Z</eventTime>

<trlrMonPlan>

<id><GT3</id>

<desc>gw test 3</desc>

<override>Y</override>

<compat>0</compat>

<manageGrp>JTB</manageGrp>

<optNotGrp />

</trlrMonPlan>

<battCharge>1</battCharge>

<battReplace xsi:nil="true" />

<foreignTrlr>Y</foreignTrlr>

<loaded>L</loaded>

<loadTime>2006-05-17T19:07:21Z</loadTime>

<cargoSnsr>2</cargoSnsr>

<cargoSnsrTime>2006-05-17T19:08:08Z</cargoSnsrTime>

<doorSnsr>2</doorSnsr>

<doorSnsrTime>2006-05-18T22:05:27Z</doorSnsrTime>

<auxSnsr>2</auxSnsr>

<auxSnsrTime>2006-05-18T22:05:27Z</auxSnsrTime>

<geofence>

<desc />

<centerPref>2</centerPref>

<nsLength>1.0</nsLength>

<ewLength>2.0</ewLength>

<startDate>2006-05-17T19:01:00Z</startDate>

<stopDate xsi:nil="true" />

<active>Y</active>

<ongoing xsi:nil="true" />

<checkInt>+00001000000</checkInt>

<entryAction>002</entryAction>

<exitAction>002</exitAction>

<centerLat>27.853055555555557</centerLat>

<centerLon>-82.80777777777777</centerLon>

</geofence>

<geoText>(near 1 miles NW of Seminole, FL)</geoText>

<insideGeo>I</insideGeo>

<geoExists>Y</geoExists>

<geoPndSelfCent>0</geoPndSelfCent>

<newGeoSent>N</newGeoSent>

</getTrailerInformationReturn>