Get Monitoring Plan List 2

Last updated
Save as PDF

getMonitoringPlanList2

This web service returns a list of monitoring plans that are compatible with the specified trailer. One use of this web service may be to determine which monitoring plans are suitable for a particular trailer. If no trailer is specified on the call, all monitoring plans are returned.

MonitoringPlan2 getMonitoringPlanList2(AssetIdentifier trailer) throws WSException

trailer: An AssetIdentifier that uniquely identifies a trailer. When a valid trailer is specified, the list will contain all monitoring plans that are compatible with that trailer. If blank, all monitoring plans are returned.

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 Trailer SCAC/ID invalid.

Sample getMonitoringPlanList2 Request

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

<soap:Body>

<getMonitoringPlanList2>

<trailer>

<id>DEET2</id>

<scac>LABU</scac>

</trailer>

</getMonitoringPlanList2>

</soap:Body>

Sample getMonitoringPlanList2 Response

<soapenv:Body>

<getMonitoringPlanList2Return>

<MonitoringPlan2>

<alertMaps xsi:nil="true"/>

<auxSensorReq>1</auxSensorReq>

<cargoSensorReq>0</cargoSensorReq>

<description>Monitoring Plan 1</description>

<doorSensorReq>0</doorSensorReq>

<id>MP1</id>

<lastChangeTimexsi:nil="true"/>

<enableTrailerSpecXmitxsi:nil="true"/>

<mileageThreshold>0.0</mileageThreshold>

<numOfTrailers>1</numOfTrailers>

<parmList xsi:nil="true"/>

<reeferReq>0</reeferReq>

<statusOverdue>0</statusOverdue>

</MonitoringPlan2>

<MonitoringPlan2>

<alertMaps xsi:nil="true"/>

<auxSensorReq>0</auxSensorReq>

<cargoSensorReq>0</cargoSensorReq>

<description>Monitoring Plan 2</description>

<doorSensorReq>0</doorSensorReq>

<id>MP2</id>

<lastChangeTimexsi:nil="true"/>

<enableTrailerSpecXmitxsi:nil="true"/>

<mileageThreshold>0.0</mileageThreshold>

<numOfTrailers>0</numOfTrailers>

<parmList xsi:nil="true"/>

<reeferReq>0</reeferReq>

<statusOverdue>0</statusOverdue>

</MonitoringPlan2>

<MonitoringPlan2>

<alertMaps xsi:nil="true"/>

<auxSensorReq>2</auxSensorReq>

<cargoSensorReq>0</cargoSensorReq>

<description>Monitoring Plan 3</description>

<doorSensorReq>0</doorSensorReq>

<id>MP3</id>

<lastChangeTimexsi:nil="true"/>

<enableTrailerSpecXmitxsi:nil="true"/>

<mileageThreshold>0.0</mileageThreshold>

<numOfTrailers>3</numOfTrailers>

<parmList xsi:nil="true"/>

<reeferReq>0</reeferReq>

<statusOverdue>3</statusOverdue>

</MonitoringPlan2>

</getMonitoringPlanList2Return>

</soapenv:Body>