Get Trailer ID List API
Available in PIT v2.3
This ILE API wraps the Get Trailer ID List web service. See its documentation for a further explanation of the input and output parameters, as well as the possible error conditions.
API Name: TTGETLST
Parameter Interface:
Parameter
|
Direction
|
Type
|
Length
|
Precision
|
Description
|
---|---|---|---|---|---|
Trailer SCAC |
Input |
Character |
4 |
n/a |
Optional (i.e. non-blank) trailer SCAC anchor value, used along with a trailer ID, allowing requests to be positioned alphabetically in the trailer list. |
Trailer ID |
Input |
Character |
10 |
n/a |
Optional (i.e. non-blank) trailer ID anchor value, used along with a trailer SCAC, allowing requests to be positioned alphabetically in the trailer list. |
Number of Trailers Requested |
Input |
Decimal |
5 |
0 |
The number of members requested up to a maximum of 200. Subsequent anchored calls are required to return customer trailer lists exceeding 200 in number. |
Number of Trailers Returned |
Output |
Decimal |
5 |
0 |
The number of members returned in the trailer SCAC and ID output arrays. The number may be 0 up to the number of trailers requested, with a maximum of 200. |
Trailer SCAC List |
Output |
Character Array (200) |
4 |
n/a |
An output array of up to 200 trailer SCACs |
Trailer ID List |
Output |
Character Array (200) |
10 |
n/a |
An output array of up to 200 trailer IDs. The actual number of non-blank trailer IDs returned will be indicated by the "Number of Trailers Returned" output parameter |
Trailer Type List |
Output |
Character Array (200) |
1 |
n/a |
An output array of up to 200 trailer types. See Equipment object documentation for valid type codes. |
Trailer UA List |
Output |
Character Array (200) |
10 |
n/a |
An output array of up to 200 trailer UAs |
Output |
Decimal |
3 |
0 |
Error Category, if any |
|
Output |
Decimal |
5 |
0 |
Error Code, if any |
|
Output |
Character |
150 varying |
n/a |
Error description, if any |
An error category of 0 means that the request was successful.