Remove Stop

Last updated
Save as PDF

removeStop

Given a load Id, stop Id and an optional company Id, this web service removes a single stop for the specified load from the Services Portal. If {all} is specified as the stop Id, then all stops for the load will be removed.

void removeStop(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 remove. If {all} is specified as the stop ID, then all stops for the load will be removed.

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>

<removeStop>

<companyId>MYCOMPANY</companyId>

<loadId>3631</loadId>

<stopId>Southern CA</stopId>

</removeStop>

</soap:Body>

Sample XML Response

<soapenv:Body>

<p431:removeStopResponse 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.