Web Services



With DocVacBasic, DocVacGold or DocVacEnterprise, you can upload documents, check on their status and retrieve information about documents using our web services.  Our documentation is a combination of the C#/Visual Studio code that is used to test them and which would be our default choice writing any custom code to integrate their usage with your IT systems and also Swagger/Swashbuckle which includes schema definitions and the required parameters for the various calls.  You can use other clients to test or use most of them (those not involving file upload/download).  One example is Postman and another is Excel 2016.

The sample code and Swagger documentation show both the standard Http status codes that can be returned e.g. 200=OK and how to use the information embedded in anything returned by the web service, including parsing out model validation errors.  A schedule of charges for using our web services can be found here. These usage charges are designed to be be minimal or zero if the web services are used correctly.  There are no usage charges with normal use of the documentvacuum.com website by an individual with a browser (automated use is billed the same way as using web services and will result in account suspension or termination). 

A. Document Status

You retrieve document status using https://documentvacuum.com/PDocDetailApi/GetPddListLatest.  You can call this every 5 minutes with no charge, or a total of 288 calls in a day.  When invoked, the service retrieves document status with a cache timeout of 120 seconds, therefore at any point in time, you know the status as of somewhere between 0 and 7 minutes ago and immediately after invoking the call you know the status as of somewhere between 0 and 2 minutes ago. The web service retrieves your documents that have been active in the last 4 hours.  More information on the various status levels can be found here

B. Upload Files

You upload files using https://documentvacuum.com/MyDocApi/UploadFiles.  The web service consumes a list of documents, we suggest uploading one document per web service call, especially if the file uploaded is large, unless you have two or more non-PDF files that you wish to combine into one document.  The C# code used to test UploadFiles can be found here and more information on uploadMode can be found here.

C. PDocDetailApi for 1 PDoc

You retrieve document status for one document using https://documentvacuum/PDocDetailApi/GetPddList where the id field is a valid id for one of your documents.  This id field will either be the PDocId field that we create as part of a document upload, or an EntityId field that you include in the header field (see C# code for more details) for each document uploaded.  You can use this when the status is more than 4 hours old and the document no longer appears in the information returned by GetPddListLatest.  The C# code used to test GetPddList can be found here.

D. PDocRowXmlApi

You can retrieve the underlying XML extracted from a document using https://documentvacuum.com/PDocRowXmlApi/GetPdrxList where the id field is a valid id for one of your documents.  The underlying XML can be useful for debugging why a particular search does not work, although we would generally use the website to do this.  We provide the same information as a web service to faciliate additional user provided logic and extraction using the raw data.  The data is not quite raw, since certain cleanup logic is applied post extraction. 

E. PDocRowClassApi for Directional mode documents (upload mode = 4)

You can retrieve the conclusions for a document processed in directional mode using https://documentvacuum.com/PDocRowClassApi/GetPdrcList where the id field is a valid id for one of your documents. 

F. PdrxstnmApi for Anonymous and Table upload modes

You can retrieve information for a document processed in either anonymous or table upload mode using https://documentvacuum.com/PdrxstdmApi/GetPdrxstdmList where the id field is a valid id for one of your documents. 

G. PdrxdtApi

Data types consist of standard data types e.g. integer and custom data types that are specific to your reference document(s) e.g. DogBreed, values {Basset Hound, Beagle}.  You can retrieve a combined list of data types using https://documentvacuum.com/PdrxdtApi/GetPdrxdtList. 

H. GetDataTableApi

You can retrieve the tables extracted from a document when the document is uploaded with TableExtraction = true using https://documentvacuum.com/DocVacDataTableApi/GetDataTableList and a valid document id. 

I. GetDataTableRowList

You can retrieve the rows associated with tables extracted from a document when the document is uploaded in Table mode using https://documentvacuum.com/DocVacDataTableRowApi/GetDataTableRowList with a valid document id. 

J. GetDataTablePdrxList

You can retrieve data points associated with tables extracted from a document when the document is uploaded using Table mode using https://documentvacuum.com/DocVacDataTablePdrxApi/GetDataTablePdrxList with a valid document id.  


See also:
DocVac Basic vs. DocVac Gold vs DocVac Enterprise

Last modified: 4/14/2021
Other articles:
Anonymous Mode Email
Web Services - Ws - PDocDetailApi.GetPddList
Combining Multiple Docs into One Doc
Billing - DocVacBasic & DocVacGold
Setup Docs
Excel to Consume Web Services
CSV Files
Financial Statement / Table Extraction
Key Term Search with Wildcards
DocVac Dictionary of Jargon

more