Ping Trailer
pingTrailer
Requests that a trailer report its current status. This causes an over-the-air status update request to be transmitted to the trailer. The trailer will respond to this request by transmitting a new status report. You must subscribe to trailer status report transactions through ESS in order to receive the resulting report.
void pingTrailer(AssetIdentifier trailer) throws WSException
- trailer: An AssetIdentifier that uniquely identifies the trailer to which a status update request will be transmitted.
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 request latest status
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 Trailer SCAC not specified.
006 Trailer ID not specified.
007 Trailer SCAC/Trailer ID invalid.
008 Failure requesting trailer status.
009 Tethered Trailer must be connected to a tractor to request status.
Sample pingTrailer Request
Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.
|
|
Sample pingTrailer Response
An empty response conveys success. If there was an error, an exception would have been thrown.
|
|