Skip to main content
Omnitracs Knowledge Base

Set Trailer Specs

setTrailerSpecs

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

void setTrailerSpecs(String companyId, AssetIdentifier trailer, TrailerSpec[] specs) 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 owned trailer whose specs will be set.
  • specs: An array of TrailerSpec objects that contains the specs to be set for the trailer. Any specs not passed will not be modified.

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.
006 Invalid Trailer Spec id: dynamically filled with invalid id
007 Invalid Trailer Spec value for id: dynamically filled with id containing invalid value
008 Invalid Trailer Spec label for id: dynamically filled with id containing invalid label

Sample setTrailerSpecs Request

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

<soapenv:Body>

   <setTrailerSpecs>

       <companyId>ACME</companyId>

       <trailer>

          <id>ALIVE595</id>

          <scac>LABU</scac>

       </trailer>

       <specs>

          <trailerSpec>

             <id>trailerType</id>

             <value>DFT</value>

          </trailerSpec>

          <trailerSpec>

             <id>length</id>

             <value>53</value>

          </trailerSpec>

          <trailerSpec>

             <id>doorType</id>

             <value>Roll</value>

          </trailerSpec>

          <trailerSpec>

             <id>suspensionType</id>

             <value>Air</value>

          </trailerSpec>

          <trailerSpec>

             <id>liftGate</id>

             <value>Yes</value>

          </trailerSpec>

          <trailerSpec>

             <id>roofType</id>

             <value>Aluminum</value>

          </trailerSpec>

          <trailerSpec>

             <id>manufacturer</id>

             <value>Trailmobile</value>

          </trailerSpec>

          <trailerSpec>

             <id>modelYear</id>

             <value>2010</value>

          </trailerSpec>

          <trailerSpec>

             <id>vin</id>

             <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>

       </specs>

   </setTrailerInformation>

</soapenv:Body>





 

Sample setTrailerSpecs Response

<soapenv:Body>

   <setTrailerSpecsResponse/>

</soapenv:Body>

  • Was this article helpful?