Skip to main content
Omnitracs Knowledge Base

Remove Load

removeLoad

Given a load Id and an optional company Id, this web service removes a load and all its stops from the Services Portal.

void removeLoad(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 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>

   <removeLoad>

      <companyId>MYCOMPANY</companyId>

      <loadId>3631</loadId>

   </removeLoad>

</soap:Body>

Sample XML Response

<soapenv:Body>

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

  • Was this article helpful?