Skip to main content
Omnitracs Knowledge Base

Get Trailer Specs

getTrailerSpecs

Given the Asset Identifier of a trailer, return an array of TrailerSpec objects for the given trailer. If a company ID is specified, return the specs for a trailer in the specified company; otherwise it returns information for the caller's company.

TrailerSpec[] getTrailerSpecs(String companyId, AssetIdentifier trailer) throws WSException

  • companyId: (optional) A string of maximum length 10 that specifies the unique company identifier. If no company is specified, the company of the authorized user will be used.
  • trailer: An AssetIdentifier that contains the identifier of the trailer whose specs will be retrieved.

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.

Exceptions

002 Required field not specified.
003 Company not authorized for integration.
004 User not authorized.
005 Trailer SCAC/ID invalid.

Sample getTrailerSpecs Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soapenv:Body>

   <getTrailerSpecs>

       <companyId>ACME</companyId>

       <trailer>

          <id>ALIVE595</id>

          <scac>LABU</scac>

       </trailer>

   </getTrailerInformation>

</soapenv:Body>



 

Sample getTrailerSpecs Response

<soapenv:Body>

   <getTrailerSpecsResponse>

       <getTrailerSpecsReturn>

          <trailerSpec>

             <id>trailerType</id>

             <label>Trailer Type</label>

             <value>DFT</value>

          </trailerSpec>

          <trailerSpec>

             <id>length</id>

             <label>Length</label>

             <value>53</value>

          </trailerSpec>

          <trailerSpec>

             <id>doorType</id>

             <label>Door Type</label>

             <value>Roll</value>

          </trailerSpec>

          <trailerSpec>

             <id>suspensionType</id>

             <label>Suspension Type</label>

             <value>Air</value>

          </trailerSpec>

          <trailerSpec>

             <id>liftGate</id>

             <label>Lift Gate</label>

             <value>Yes</value>

          </trailerSpec>

          <trailerSpec>

             <id>roofType</id>

             <label>Roof Type</label>

             <value>Aluminum</value>

          </trailerSpec>

          <trailerSpec>

             <id>manufacturer</id>

             <label>Manufacturer</label>

             <value>Trailmobile</value>

          </trailerSpec>

          <trailerSpec>

             <id>modelYear</id>

             <label>Model Year</label>

             <value>2010</value>

          </trailerSpec>

          <trailerSpec>

             <id>vin</id>

             <label>VIN</label>

             <value>1B234ZC4</value>

          </trailerSpec>

          <trailerSpec>

             <id>customSpec1</id>

             <label>Trailer Color</label>

             <value>White</value>

          </trailerSpec>

          <trailerSpec>

             <id>customSpec2</id>

             <label>Tire Manufacturer</label>

             <value>Goodyear</value>

          </trailerSpec>

        </getTrailerSpecsReturn>

    </getTrailerSpecsResponse>

</soapenv:Body>

  • Was this article helpful?