Update Stop

Last updated
Save as PDF

updateStop

Given a Stop object, this web service stores information for a new stop or updates an existing stop on the Services Portal.

void updateStop(string companyId, Stop stopInfo) 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.
stopInfo: A Stop object with the details for creating or updating the stop.

Required elements for create:
    - stop - loadId*
    - stop - stopId*
    - stop - sequenceNum*
    - stop - type
    - stop - customerCode
    - stop - latitude*
    - stop - longitude*
    - stop - address1
    - stop - city
    - stop - state

Notes:
If the combination of loadId and stopId already exists, the stop will be updated; otherwise, the stop will be created.
The sequenceNum must be unique for the load.
Items marked above with '*' are also required for the update operation. The others may be set to null to indicate no change is desired.

Optional elements:
    - stop - name
    - stop - address2
    - stop - postalCode
    - stop - region
    - stop - country
    - stop - contact
    - stop - phone
    - stop - earlyTime
    - stop - lateTime
    - stop - completeTime
    - stop - billOfLadingNum
    - stop - pieces
    - stop - weight
    - stop - commodity
    - stop - temperature
    - stop - hazmatCodes
    - stop - comments
    - stop - generalUse1
    - stop - generalUse2
    - stop - generalUse3

For all elements except loadId and stopId:
    - To change, set to new value.
    - To remove the existing value, set to blank.
    - If no change is desired, set to null.

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>

<updateStop>

<companyId>MYCOMPANY</companyId>

<stopInfo>

<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 bags</pieces>

<weight>225 lbs.</weight>

<commodity/>

<temperature>40</temperature>

<hazmatCodes>1.3</hazmatCodes>

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

<generalUse1/>

<generalUse2/>

<generalUse3/>

</stopInfo>

</updateStop>

</soap:Body>

Sample XML Response

<soapenv:Body>

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

</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.
008 Invalid sequence number.
009 Invalid stop type.
010 Invalid customer code.
011 Invalid latitude.
012 Invalid longitude.
013 Invalid stop name.
014 Invalid address line 1.
015 Invalid address line 2.
016 Invalid city.
017 Invalid state.
018 Invalid postal code.
019 Invalid region.
020 Invalid country.
021 Invalid contact.
022 Invalid phone number.
023 Invalid early time.
024 Invalid late time.
025 Invalid complete time.
026 Invalid bill of lading number.
027 Invalid pieces.
028 Invalid weight.
029 Invalid commodity.
030 Invalid temperature.
031 Invalid hazmat codes.
032 Invalid comments.
033 Invalid generalUse1.
034 Invalid generalUse2.
035 Invalid generalUse3.