VIR Integration Overview
Remote integration with the Vehicle Inspection Report (VIR) is provided through web services.
Web Services
The current version of the VIR integration interface supports a single Web Service that provide the ability for integrators to manage inspection reports which contain defects.
Web Services in Production
The production web services can be categorized as follows:
Inspection Report Management
Event Subscription Service
VIR is integrated with the Event Subscription Service (ESS) provided by the Omnitracs Services Portal (QSP) which includes access to event-based data. ESS is built upon the publish/subscribe model. Applications that are hosted on the QSP Server may use ESS to make transactions available for publication. In turn, ESS provides a common interface (accessible through web services) that allows interested remote applications to subscribe to, and subsequently consume, various transactions. These transactions are primarily event-based. The ESS transaction interface provides the means to receive these event feeds in near real time.
Asynchronous Events
It is important to note that some of the web services provided by the integration interface result in the generation, and subsequent publishing, of events to ESS. The integrator must subscribe to specific ESS events in order to retrieve or monitor the request in these cases. For example, when an Inspection Report is closed, the application initiates a message to be delivered to a mobile device. The web service does not block the caller. They generate the request and return to the caller immediately. The response from the mobile will wind up being published to ESS. The caller must consume the ESS event if it is interested in the response.
Specifically, VIR events are published to ESS using Transactions T.7.01.0, T.7.02.0 and T.7.03.0.
- An inspection report with defects is received from a mobile device.
- Forward Message Confirmation
- Forward Message Delivery Notification