Check Monitoring Plan Compatibility

Last updated
Save as PDF

checkMonitoringPlanCompatibility

The checkMonitoringPlanCompatibility web service provides the means to check whether or not a trailer, given a SCAC and trailer identifier, is compatible with the trailer sensor (cargo, door, and auxiliary) requirements of a specific monitoring plan. A user may want to check compatibility prior to a monitoring plan assignment. If a plan does not meet required sensors during assignment, the assignment of the monitoring plan will be prevented.

MonPlanCompatibility checkMonitoringPlanCompatibility(String monitoringPlanId, AssetIdentifier trailer) throws WSException

monitoringPlanId: The identifier of the monitoring plan.
trailer: An AssetIdentifier containing the SCAC and ID of the trailer to be checked for monitoring plan compatibility.

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

002 Required field not specified.
003 Company not authorized for integration.
004 User not authorized.
005 Monitoring Plan ID not specified.
006 Monitoring Plan ID invalid.
007 Trailer SCAC not specified.
008 Trailer ID not specified.
009 Trailer SCAC/Trailer ID invalid.

Sample checkMonitoringPlanCompatibility Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soapenv:Body>

<checkMonitoringPlanCompatibility>

<monitoringPlanId> DEES</monitoringPlanId>

<trailer>

<id>ALIVE595</id>

<scac>LABU</scac>

</trailer>

</checkMonitoringPlanCompatibility>

</soapenv:Body>

Sample checkMonitoringPlanCompatibility Response

<soapenv:Body>

<checkMonitoringPlanCompatibilityResponse>

<checkMonitoringPlanCompatibilityReturn>

<cargoSensor>0</cargoSensor>

<doorSensor>0</doorSensor>

<auxSensor>0</auxSensor>

<overall>0</overall>

</checkMonitoringPlanCompatibilityReturn>

</checkMonitoringPlanCompatibilityResponse>

</soapenv:Body>