Rename Trailer
renameTrailer
Rename a trailer given the asset identifier of the existing trailer and the asset identifier of the trailer to be renamed. This web service also accepts a boolean value indicating whether to migrate historical data to the new SCAC/trailer identifier.
Untethered units that currently have an owned SCAC, must be renamed with an existing, owned SCAC. Likewise, if the untethered trailer is foreign, it must be renamed with an existing foreign SCAC. Tethered units on the other hand, are allowed to be changed from a foreign SCAC to an owned SCAC (and vice versa).
void renameTrailer(AssetIdentifier trailer, AssetIdentifier newTrailer, boolean bHistory) throws WSException
- *trailer: The current AssetIdentifier of the trailer to be renamed.
- *newTrailer: The AssetIdentifier that defines the new trailer identity.
- bHistory: A boolean indicating whether to migrate the event and position history records for this trailer to the new trailer identifier. As of November 2014, this parameter will be ignored. The historical records will automatically be transferred to the new trailer identifier.
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 maintain trailers
Exceptions
002 Required field not specified.
003 Company not authorized for integration.
004 User not authorized.
005 Trailer SCAC not specified or contains invalid characters.
006 Trailer ID not specified or contains invalid characters.
007 Trailer SCAC/Trailer ID invalid.
008 New Trailer SCAC not specified.
009 New Trailer ID not specified.
010 New Trailer SCAC/Trailer ID invalid.
011 New Trailer SCAC/Trailer ID already exists.
012 Trailer ID's foreign/owned designation may not be changed.
013 Convert Trailer history not specified.
014 Convert Trailer history invalid.
015 Trailer ID cannot be changed for this device type.
Sample renameTrailer Request
Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.
|
Sample renameTrailer Response
|