Assign Monitoring Plan
assignTrailerMonitoringPlan
The assignTrailerMonitoringPlan web service provides the means to assign a monitoring plan to a trailer and, optionally, to set the trailer's notification group. Trailers are identified by their SCAC and Trailer ID. When specifying a monitoring plan, the plan must be active and it must be compatible with the trailer. A trailer must be equipped with the appropriate sensors in order to be compatible with a given monitoring plan.
void assignTrailerMonitoringPlan(AssetIdentifier trailer, String monitoringPlanId, String optionalNotificationGroup) throws WSException
- trailer An AssetIdentifier containing the SCAC and ID of the trailer to be assigned a monitoring plan.
- monitoringPlanId: The identifier of the monitoring plan which will be assigned to the trailer. Monitoring Plans have a maximum length of 4 characters. Only active and compatible monitoring plans are acceptable.
- optionalNotificationGroup: The group to which alerts will go. Optional Notification Group has a maximum length of 10 characters. If specified, the group must be a defined TrailerTRACS user group. Specify *NONE to set this to no group.
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
- Can assign monitoring plans OR can maintain trailers OR can maintain monitoring plans
Customer integrators are authorized to their own company's data only.
Exceptions
001 Unknown Error.
002 Required field not specified.
003 Company not authorized for integration.
004 User not authorized.
005 Monitoring Plan ID invalid.
006 Trailer ID or SCAC not specified.
007 Trailer SCAC/Trailer ID invalid.
008 Trailer not compatible with specified monitoring plan.
009 Monitoring plan not active.
010 Optional Notification Group invalid.
011 Cannot assign a monitoring plan to a trailer currently under Emergency Tracking.
Sample assignTrailerMonitoringPlan Request
Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.
|
|
Sample assignTrailerMonitoringPlan Response
An empty response conveys success. If there was an error, an exception would have been thrown.
|
|