Check Data Sharing Status
checkDataSharing
The checkDataSharing web service is used to check the status of a data sharing assignment that has previously been enabled for a T2-equipped trailer. When data sharing is enabled/disabled for a mobile unit, it does not take effect instantly. Therefore, the successful enablement cannot be determined solely by the return status of an enableDataSharing or disableDataSharing web service call. However, this web service (checkDataSharing) may be used to check the status of the data sharing assignment.
String checkDataSharing(AssetIdentifier trailer, String partner) throws WSException
- trailer : An AssetIdentifier that contains the identifier of the trailer to be checked.
- partner : The ID of the partner with whom the data sharing relationship exists.
This web service returns a string containing one of the following status codes:
00 Data sharing currently disabled
01 Data sharing currently enabled
02 Data sharing enable pending
03 Data sharing disable pending
04 Data sharing in failed state
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
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.
Sample checkDataSharing Request
Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.
|
|
Sample checkDataSharing Response
An empty response conveys success. If there was an error, an exception would have been thrown.
|
|