Skip to main content
Omnitracs Knowledge Base

Scanning Integration


This page provides a detailed description with examples of how to use the EIP Web Services (WS) to integrate with the In-Cab Scanning application. This integration will use 2 EIP Web Services.

The EIP IdentityType value for Scanning integration is: SCAN

We recommend using the Omnitracs URL: for all your new development.

Message XSD:


The Available Scanning Methods are:

This page also provides additional infrastructure requirements required at the customer side to receive scan documents through FTP channel through EIP (described below).

Errors and Success Messages

The EIP Web Services responses will include detail information of any errors or warnings. Errors in which case no processing can occur will be immediately returned to the client as SoapFault. In case of other errors the web service methods will send collection of errors and/or warnings . These are covered for each method on the method's name link.


Scanning Web Service Example

Click here for a walk through and code


Scanning 2.0 - Infrastructure requirements

There are additional infrastructure requirement required at the customer side to enable a customer to receive the scan documents through FTP channel when the scan documents are delivered through EIP.

1. The following NAT IP addresses of EIP Servers are to be added on the customer's side firewall policy to let the FTP requests to flow through it. On an event of a change on the NAT IP addresses of EIP servers in future, this page will be updated to reflect the changed IP address, which should be added to the firewall policy.


Please note, if the firewall policy is not updated, the scanned documents CANNOT be delivered to a customer's FTP server as the requests gets rejected by the customer's side firewall policy.

2. Max Number of connections parameter should be at least minimum of 40 connections

3. FTP must be allowed through Passive mode.

4. The username for accessing the FTP credentials, should not contain special characters like, "/", "\" etc.

5. Customers who wanted meta data must accept files with "" (Tilde) characters on the filename as the meta data file (XML content) has filename starting with "".

  • Was this article helpful?