Skip to main content
Omnitracs Knowledge Base

Get Trailer Information API

This ILE API wraps the Get Trailer Information Web Service. See its documentation for a further explanation of the input and output parameters, as well as the possible error conditions.

API Name:  TTTRLINFO

Parameter Interface:

 

Parameter

 

 

Direction

 

 

Type

 

 

Length

 

 

Precision

 

 

Description

 

SCAC

Input

Character

4

n/a

Standard Carrier Alpha Code (SCAC) for the trailer

Trailer ID

Input

Character

10

n/a

Identifier for the trailer

Trailer Information 

Output

Character

396

n/a

Trailer Information string associated with the given trailer identifier.
(see breakout of information string below)

Trailer 'City' Proximity Information

Output

Character

98

n/a

'City' Proximity string associated with the given trailer identifier.
(see breakout of city/town information string below)

Trailer 'Town' Proximity Information

Output

Character

98

n/a

'Town' Proximity string associated with the given trailer identifier.
(see breakout of city/town information string below)

Error Category

Output

Decimal

3

0

Error Category, if any

Error Code

Output

Decimal

5

0

Error Code, if any

Error Description

Output

Character

150 varying

n/a

Error description, if any

An error category of 0 means that the trailer has been assigned to the given trailer type.
 

Trailer Information String Consists of the following values:

 

Name

 

 

Length

 

 

Description

 

Trailer Type

3

Trailer Type

Position Time

20

Timestamp indicating the last known Position Time

Tractor Identifier

10

Tractor Identifier (if connected to an Omni unit)

Tractor SCAC

4

Standard Carrier Alpha Code (SCAC) for the tractor

Lost Trailer

1

Flag indicating if trailer is considered lost

Event Description

25

Last known event on the trailer

Event Time

20

Timestamp indicating the time of last known event

Monitoring Plan Identifier

4

Monitoring Plan in effect on the trailer 

Monitoring Plan Description

20

Description of Monitoring Plan

Monitoring Plan Override

1

Monitoring Plan Override in effect?
'N' = No
'Y' = Yes

Monitoring Plan Compatible

1

Does the trailer meet all the Monitoring Plan's Compatability?
'0' = Yes
'1' = No 

Monitoring Plan Management Group

10

Trailer Management Group assigned to the trailer via the Monitoring Plan

Monitoring Plan Optional Notification Group

10

Optional Notification Group assigned to the trailer via the Monitoring Plan 

Battery Status

1

 

Last Battery Replacement Time

20

Timestamp indicating the time the battery was last replaced on the untehtered trailer tracking unit.    

Foreign Trailer

1

Indicates if the trailer is foreign or owned.
'N' = No
'Y' = Yes 

Loaded Status

1

Indicates if the trailer's loaded status.
'L' = Loaded
'E' = Empty
'U' = Unknown

Loaded Time

20

Timestamp indicating the time of the change to the loaded status.

Cargo Sensor

1

Indicates the state of the cargo sensor.
'0' = Sensor not installed
'1' = Empty
'2' = Loaded
'3' = Not enabled
'U' = Unknown

Cargo Sensor Time

20

Timestamp indicating the time of the change to the cargo sensor. 

Door Sensor 

1

Indicates the state of the door sensor.
'0' = Sensor not installed
'1' = Open
'2' = Closed
'3' = Not enabled
'U' = Unknown 

Door Sensor Time 

20

Timestamp indicating the time of the change to the door sensor.

Auxiliary Sensor

1

Indicates the state of the auxiliary sensor.
'0' = Sensor not installed
'1' = Open
'2' = Closed
'3' = Not enabled
'U' = Unknown 

Auxiliary Sensor Time 

20

Timestamp indicating the time of the change to the auxiliary sensor. 

Geofence Description

40

Geofence Description 

Geofence Center Preference

1

Indicates the center option for the geofence
'1' = Self-centered
'2' = Lat/long-centered 

Geofence Center Latitude

18

Latitude of the geofence centerpoint 

Geofence Center Longitude 

18

Longitude of the geofence centerpoint  

Geofence North/South Length 

5

North/South length (height) of the geofence

Geofence East/West Length  

5

East/West length (width) of the geofence

Geofence Start Date

20

Timestamp indicating the activation time of the Geofence

Geofence Stop Date

20

Timestamp indicating the deactivation time of the Geofence

Geofence Active

1

Indicates whether or not the geofence is active
'Y' = geofence is active
'N' = geofence is not active 

Geofence Ongoing?

1

"Y" or "N", ongoing means no specified stop date

Geofence Check Interval  

12

Indicates whether or not the geofence is ongoing and the interval the terminal will check its geofence position status when not under external power.
Format +DDDDDHHMMSS
'+00000000000' = Never
'+00000000500' = 5 mins
'+00000001500' = 15 mins
'+00000003000' = 30 mins
'+00000010000' = 1 hr
'+00000020000' = 2 hrs
'+00000030000' = 3 hrs
'+00000040000' = 4 hrs
'+00000060000' = 6 hrs
'+00000080000' = 8 hrs
'+00000120000' = 12 hrs
'+00001000000' = 1 day

Geofence Entry Action

3

Indicates the action taken by the terminal when a trailer enters the geofence
'000' = Ignore completely (the terminal should take no action when it detects that the trailer enters the geofence)
'001' = Send event with next scheduled message  (the terminal should send the message the next time it sends a scheduled message)
'002' = Send event immediately (the terminal should send the message as soon as it detects that the trailer enters the geofence)
'003' = Send event immediately and stay awake (the terminal should send the message as soon as soon as it detects that the trailer enters the geofence and stay powered up (awake) until the stay awake interval is reached) 

Geofence Exit Action

3

Indicates the action taken by the terminal when a trailer exits the geofence
'000' = Ignore completely (the terminal should take no action when it detects that the trailer exits the geofence)
'001' = Send event with next scheduled message  (the terminal should send the message the next time it sends a scheduled message)
'002' = Send event immediately (the terminal should send the message as soon as it detects that the trailer exits the geofence)
'003' = Send event immediately and stay awake (the terminal should send the message as soon as soon as it detects that the trailer exits the geofence and stay powered up (awake) until the stay awake interval is reached)  

Geofence Text

10

Geofence Text

Inside Geofence 

1

Indicates whether or not this trailer is inside its geofence 
'Y' = The trailer is inside its geofence
'N' = The trailer is not inside its geofence

Geofence Exists

1

Indicates whether or not a geofence exists for this trailer
'Y' = A geofence exists for this trailer
'N' = No geofence exists for this trailer 

Geofence Pending Self Centering

1

Indicates whether or not the centerpoint of self-centered geofence is pending (center location unknown).
'0' = Not self-center pending (center location known)
'1' = Self-center pending (center location unknown)

Geofence Sent

1

Indicates whether or not an updated geofence is being sent to the trailer
'Y' = A new geofence has been sent and is pending
'N' = No new geofence has been sent 

City/Town Proximity Information String Consists of the following values:

 

Name

 

 

Length

 

 

Description

 

City/Town Name

25

City/Town Name

Country

5

Country of City/Town

Direction

3

Direction

Distance

6

Distance to City/Town

Place Name

25

Alias Name (if applicable)

Place Type

20

Type

State

12

State

Zip

12

Zip

  • Was this article helpful?