Get Monitoring Plan Details

Last updated
Save as PDF

DEPRECATED

This webservice is considered deprecated as of March 2016 in favor of the new Get Monitoring Plan Details 2, which utilizes the new Monitoring Plan 2 object.
Please make plans to adopt the new webservice in your integration code.

getMonitoringPlanDetails

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 T2 Configuration Parameters page.

MonitoringPlan getMonitoringPlanDetails(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 getMonitoringPlanDetails Request

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

<soap:Body>

<getMonitoringPlanDetails>

<monitoringPlanID>IDLE</monitoringPlanID>

</getMonitoringPlanDetails>

</soap:Body>

Sample getMonitoringPlanDetails Response

<soapenv:Body>

<getMonitoringPlanDetailsReturn>

<alertMap>000000000000000000000000000000000000000000000000</alertMap>

<auxSensorReq>0</auxSensorReq>

<cargoSensorReq>0</cargoSensorReq>

<description>Idle Plan</description>

<doorSensorReq>2</doorSensorReq>

<reeferReq>0</reeferReq>

<id>IDLE</id>

<lastChangeTime>614550326</lastChangeTime>

<markedDeletion>0</markedDeletion>

<numOfTrailers>0</numOfTrailers>

<parmList>

<MonPlanParm>

<parmId>01121</parmId>

<value>001</value>

</MonPlanParm>

<MonPlanParm>

<parmId>01124</parmId>

<value>001</value>

</MonPlanParm>

<MonPlanParm>

<parmId>01126</parmId>

<value>+00000000500</value>

</MonPlanParm>

</parmList>

<statusOverdue>1</statusOverdue>

</getMonitoringPlanDetailsReturn>

</soapenv:Body>