Skip to main content
Omnitracs Knowledge Base

Set Scheduled Reefer Monitoring API

(plus) Available in PIT v2.3

This ILE API wraps the Set Scheduled Reefer Monitoring Web Service. See its documentation for a further explanation of the input and output parameters, as well as the possible error conditions.

API Name:  T2SETRMON

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

Active

Input

Character

1

n/a

Scheduled Reefer Monitoring Active? "1" = Yes, "0" = No

Start Date

Input

Character

20

n/a

Monitoring start date. Format: YYYY-MM-DDTHH:MM:SSZ

Stop Date

Input

Character

20

n/a

Monitoring stop date. Format: YYYY-MM-DDTHH:MM:SSZ

Ongoing?

Input

Character

1

n/a

Is reefer monitoring ongoing (ignores end time)? "1" = Yes, "0" = No

Temperature Notify Time

Input

Decimal

5

0

The amount of time (in minutes) a temperature is allowed to remain out of range before generating an over/under temperature alert.

Temperature Sensor

Input

Character

1

n/a

Indicates the temperature sensor to use for monitoring. Valid values are: "0" = Return Air, "1" = Supply Air, "2" = Both

Use Driver Set Point

Input

Character

1

n/a

Indicates if the driver set point should be used for the target temperature for monitoring. "1" = Yes, "0" = No

Temperature Set Point

Input

Decimal

5

2

Indicates the target temperature for the sensor.

Temperature Tolerance

Input

Decimal

5

2

Indicates the amount of temperature fluxuation allowed for the sensor before being considered "out of range".

Notification Email 1

Input

Character

50

n/a

An email address to which notifications should be sent.

Notification Email 2

Input

Character

50

n/a

Same as above.

Notification Email 3

Input

Character

50

n/a

Same as above.

Notification Email 4

Input

Character

50

n/a

Same as above.

Notification Email 5

Input

Character

50

n/a

Same as above.

Notification Email 6

Input

Character

50

n/a

Same as above.

Notification Email 7

Input

Character

50

n/a

Same as above.

Notification Email 8

Input

Character

50

n/a

Same as above.

Notification Email 9

Input

Character

50

n/a

Same as above.

Notification Email 10

Input

Character

50

n/a

Same as above.

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 request was sent successfully.

  • Was this article helpful?