Get Trailer ID List
getTrailerIDList
Given a trailer identifier (optional) and a number of trailers to return, this web service returns a list of Equipment objects in alphabetical order by trailer ID.
Equipment[] getTrailerIDList(AssetIdentifier trailer, int numOfTrailers) throws WSException
- trailer: (optional)A TTWebServices AssetIdentifier containing the SCAC and ID. The returned list will begin after (alphabetically) the trailer (ID & SCAC) that is specified on the call. When the SCAC is blank, the list will begin with the first trailer on file sorted alphabetically by trailer ID. When the SCAC is specified with no trailer ID, the list will begin with the first trailer on record with the specified SCAC.
- numberOfTrailers: The number of trailers to return in the list. The allowed range is 1 to 32766.
Returns a null string on exceptions; otherwise returns an array of Equipment objects.
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.
Sample XML Request
Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.
|
|
Sample XML Response
|
|
Exceptions
001 Unknown Error.
002 Required field not specified.
003 Company not authorized for integration.
004 User not authorized.
005 No trailers found.
006 Invalid number of records specified.
007 Invalid character found in SCAC.
008 Invalid character found in Trailer ID.
009 Invalid SCAC, SCAC can be no more than 4 characters.
010 Invalid Trailer ID, ID can be no more than 10 characters.