Skip to main content
Omnitracs Knowledge Base

Monitoring Plan 2

Information about a Monitoring Plan is implemented in the MonitoringPlan2 object.  The attributes of the MonitoringPlan2 object are:

 

Attribute

 

 

Description

 

alertMaps

An array of AlertMap objects defining the alert maps of each device type.

auxSensorReq

"0" = The trailer does not require an aux sensor in order to assign this plan.
"1" = The trailer must be aux-sensor equipped in order to assign this plan.

cargoSensorReq

"0" = The trailer does not require a cargo sensor in order to assign this plan.
"1" = The trailer must be cargo-sensor equipped in order to assign this plan. 

description

The monitoring plan's description.

doorSensorReq

"0" = The trailer does not require a door sensor in order to assign this plan.
"1" = The trailer must be door-sensor equipped in order to assign this plan.

id

The monitoring plan's unique ID.

lastChangeTime

The last time the plan was changed. It is now displayed in the following format in the GMT time zone: YYYY-MM-DDTHH:MM:SSZ.

mileageThreshold

If this value is exceeded alerts will be sent out based on the monitoring plan's alert notification settings.

numOfTrailers

The number of trailers presently assigned to the plan.

parmList

An array of MonPlanParm2 objects containing information about the parameters of the monitoring plan.

reeferReq

"0" = The trailer does not require a reefer in order to assign this plan.
"1" = The trailer must be reefer equipped in order to assign this plan.

statusOverdue

An value (in days) after which a status report is considered overdue.

WSDL Definition

MonitoringPlan2 object as defined in the WSDL

<complexType name="MonitoringPlan2">

   <sequence>

      <element name="alertMaps" nillable="true" type="impl:ArrayOf_tns2_nillable_AlertMap"/>

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

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

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

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

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

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

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

      <element name="numOfTrailers" type="xsd:int"/>

      <element name="parmList" nillable="true" type="impl:ArrayOf_tns2_nillable_MonPlanParm2"/>

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

      <element name="statusOverdue" type="xsd:int"/>

   </sequence>

</complexType>








 

XML Sample

MonitoringPlan2 object in XML.

<MonitoringPlan2>

   <alertMaps>

      <alertMap>

         <values>000000000000000000000</values>

         <mobileType>11</mobileType>

      </alertMap>

      <alertMap>

         <values>000000000000</values>

         <mobileType>12</mobileType>

      </alertMap>

      <alertMap>

         <values>000000000000000000000000000000000000000000000000</values>

         <mobileType>10</mobileType>

      </alertMap>

   <alertMaps>

   <auxSensorReq>0</auxSensorReq>

   <cargoSensorReq>2</cargoSensorReq>

   <description>Sensitive Cargo</description>

   <doorSensorReq>2</doorSensorReq>

   <id>CRGO</id>

   <lastChangeTime>2012-11-18T17:46:45Z</lastChangeTime>

   <mileageThreshold>0.0</mileageThreshold>

   <numOfTrailers>7</numOfTrailers>

   <parmList>

      <MonPlanParm>

         <parmId>01121</parmId>

         <value>001</value>

         <mobileType>10</mobileType>

      </MonPlanParm>

      <MonPlanParm>

         <parmId>01124</parmId>

         <value>001</value>

         <mobileType>10</mobileType>

      </MonPlanParm>

      <MonPlanParm>

         <parmId>01126</parmId>

         <value>+00000000500</value>

         <mobileType>10</mobileType>

      </MonPlanParm>

      <MonPlanParm>

         <parmId>51052</parmId>

         <value>+00000000500</value>

         <mobileType>12</mobileType>

      </MonPlanParm>

      <MonPlanParm>

         <parmId>00100</parmId>

         <value>1800</value>

         <mobileType>11</mobileType>

      </MonPlanParm>

      <MonPlanParm>

         <parmId>00101</parmId>

         <value>0</value>

         <mobileType>11</mobileType>

      </MonPlanParm>

   </parmList>

   <statusOverdue>0</statusOverdue>

   <reeferReq>0</reeferReq>

</MonitoringPlan2>

  • Was this article helpful?