Get Load

Last updated
Save as PDF

getLoad

Given a load Id and an optional company Id, this web service returns a Load object.

void getLoad(string companyId, string loadId) 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.
loadId: A string of maximum length 20 that identifies the load to be returned.

Returns a null string on exceptions; otherwise returns a Load object.

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

Sample XML Request

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

<soap:Body>

<getLoad>

<companyId>MYCOMPANY</companyId>

<loadId>3631</loadId>

</getLoad>

</soap:Body>

Sample XML Response

<soapenv:Body>

<p431:getLoadResponse xmlns:p431="websvcs.qtwebws"/>

<getLoadReturn>

<loadId>3631</loadId>

<driver1Id>KJONES</driver1Id>

<driver2Id/>

<vehicle>

<id>ABC12345</id>

<scac/>

</vehicle>

<trailer1>

<id>DEF6789</id>

<scac>ABCD</scac>

</trailer1>

<trailer2/>

<trailer3/>

<hazmatCodes>1.3</hazmatCodes>

<comments>Load needs to be delivered by 10:00</comments>

<generalUse1/>

<generalUse2/>

<generalUse3/>

</getLoadReturn>

</p431:getLoadResponse>

</soapenv:Body>

Exceptions

001 Unknown Error.
003 Company not authorized for integration.
004 User not authorized.
005 Invalid company id.
006 Invalid load id.