DocViewer API overview

The DocService SecuritySessionSvc is a collection of four operations that allows users to view packages within the DocViewer when using the Expere Document Services (EDS) Tool Suite and other systems including third-party applications.

Overview

Web Service Document Service
Target namespace http://tempuri.org/ (default namespace URI, replace with meaningful URI)
Port DocServices.Common.Interfaces.IEDocService
Location https://ct-expere.wolterskluwerfs.com/DocServices/Services/SecuritySession/SecuritySessionSvc.svc
Protocol SOAP
Transport protocol SOAP over HTTP

Operations

The SecuritySessionSvc consists of the following operations:

  • BeginSession: the BeginSession operation is the primary service call to start a DocViewer session. With the provided transaction data, it utilizes the repository specified in the appSettings.config to autoselect documents within packages or load specific list of documents.
  • BeginSessionWithREQ: the BeginSessionWithREQ service call starts a DocViewer session with the provided REQ file data. It does not look to the repository for content. This is mainly used for testing individual REQ documents.
  • EndSession: the EndSession service call is utilized when the DocViewer session should be completed. Passing in the session id, the session will be completed and the resulting session data will be returned. Session data returned includes the modified transaction data, document statuses, and the selected package.
  • PreCacheSession: the PreCacheSession is a service call that may be used to seed documents and packages into the DocViewer cache to help decrease the time needed to run auto selection for a transaction. This can be called as soon as you know what packages or documents you will be using with DocViewer.
  • CheckRequiredData: the CheckRequiredData call starts a DocViewer session only if required data is missing in the transaction.

Additional resources

A companion compiled help file, Expere Doc Viewer Integration is available here