Get Stop

Last updated
Save as PDF

getStop

Given a load Id, stop Id and an optional company Id, this web service returns an array of Stop objects in order by sequence number. If {all} is specified as the stop Id, then all stops for the load will be returned.

Stop[] getStop(string companyId, string loadId, string stopId) 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 containing the stop(s).
stopId: A string of maximum length 20 that identifies the stop to be returned. If {all} is specified as the stop Id, then all stops for the load will be returned.

Returns a null string on exceptions; otherwise returns an array of Stop 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
- None

Sample XML Request

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

<soap:Body>

<getStop>

<companyId>MYCOMPANY</companyId>

<loadId>3631</loadId>

<stopId>Southern CA</stopId>

</getStop>

</soap:Body>

Sample XML Response

<soapenv:Body>

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

<getStopReturn>

<Stop>

<loadId>3631</loadId>

<stopId>Southern CA</stopId>

<sequenceNum>1</sequenceNum>

<type>P</type>

<customerCode>ACME</customerCode>

<latitude>32.8952</latitude>

<longitude>-117.1957</longitude>

<name>ACME FRUIT</name

<address1>100 MAIN ST</address1>

<address2/>

<city>San Diego</city>

<state>CA</state>

<postalCode>92121</postalCode>

<region/>

<country>US</country>

<contact>Jim Smith</contact>

<phone/>

<earlyTime>2012-11-05T16:00:00Z</earlyTime>

<lateTime>2012-11-05T20:00:00Z</lateTime>

<completeTime/>

<billOfLadingNum>752</billOfLadingNum>

<pieces>100</pieces>

<weight>225</weight>

<commodity/>

<temperature>40</temperature>

<hazmatCodes>1.3</hazmatCodes>

<comments>Use loading dock in back</comments>

<generalUse1/>

<generalUse2/>

<generalUse3/>

</Stop>

</getStopReturn>

</p431:getStopResponse>

</soapenv:Body>

Exceptions

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