Get Monitoring Plan Details 2

Last updated
Save as PDF

getMonitoringPlanDetails2

Gets detailed information about a monitoring plan given a monitoring plan identifier.

Additional information about the parameters returned for a monitoring plan can be found on the Configuration Parameters page.

MonitoringPlan2 getMonitoringPlanDetails2(String monitoringPlanID) throws WSException

monitoringPlanID: A string of maximum length 4 that uniquely identifies a monitoring plan.

Authorization Requirements

The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.

Required Application Licenses
- Remote Integration

Required User Permissions
- Can use Trailer Tracks

Customer integrators are authorized to their own company's data only.

Exceptions

001 Unknown error.
003 Company not authorized for integration.
004 User not authorized.
005 Monitoring Plan ID invalid.

Sample getMonitoringPlanDetails2 Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, see the Web Service Security page.

<soap:Body>

<getMonitoringPlanDetails2>

<monitoringPlanID>IDLE</monitoringPlanID>

</getMonitoringPlanDetails2>

</soap:Body>

Sample getMonitoringPlanDetails2 Response

<soapenv:Body>

<getMonitoringPlanDetails2Return>

<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>

<alertMap>

<values>000000000</values>

<mobileType>15</mobileType>

</alertMap>

<alertMaps>

<auxSensorReq>0</auxSensorReq>

<cargoSensorReq>0</cargoSensorReq>

<description>Idle Plan</description>

<doorSensorReq>2</doorSensorReq>

<reeferReq>0</reeferReq>

<id>IDLE</id>

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

<mileageThreshold>0.0</mileageThreshold>

<numOfTrailers>0</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>1</statusOverdue>

</getMonitoringPlanDetails2Return>

</soapenv:Body>