Skip to main content
Omnitracs Knowledge Base

Enable Data Sharing

enableDataSharing

The enableDataSharing web service will assign an existing rule to a specified T2-equipped trailer. Data sharing may be enabled to allow message and position data from/to a T2-equipped trailer to be copied to another SP customer account. The definition of the data sharing rule must have been created by Omnitracs prior to calling this web service.

void enableDataSharing(AssetIdentifier trailer, String partner) throws WSException

  • trailer : An AssetIdentifier that contains the identifier of the trailer whose data will be shared.
  • partner : The ID of the partner who is to receive the data that is being shared.

 

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
- Can maintain data sharing

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

Exceptions

002 Required field not specified.
003 Company not authorized for integration.
004 User not authorized.
005 Trailer not found.
006 Invalid Partner ID specified.
007 The specified Partner ID is not unique. Please contact Omnitracs.
008 Data sharing not supported.

 

 

Sample enableDataSharing Request

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

<soapenv:Body>

    <enableDataSharing>

        <trailer xmlns="">

            <id>TRLR100</id>

            <scac>ACME</scac>

        </trailer>

        <partner>ACMEFRIEND</partner>

    </enableDataSharing>

</soapenv:Body>

 

Sample enableDataSharing Response

An empty response conveys success. If there was an error, an exception would have been thrown.

<soapenv:Body>

    <enableDataSharingResponse/>

</soapenv:Body>

  • Was this article helpful?