Skip to main content
Omnitracs Knowledge Base

Set User Depot

Given a user ID, depot ID and optional company ID, this web service updates a user's depot on the Services Portal.

void setUserDepot(String companyId, String userId, int depotId) 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.
  • userId: A string of maximum length 10 that identifies the user whose depot should be updated.
  • depotId: The depot ID to assign to the user. Valid values are 0-32767.


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
- Admin role

Customer integrators are authorized to their own company's data only.


Sample XML Request


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









Sample XML Response



<p431:setUserDepotResponse xmlns:p431="http://websvcs.omaswebws"/>





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

  • Was this article helpful?