HotDocs Web Service API Overview

The HotDocs Web Service is a RESTful web service, hosted in IIS, which exposes fundamental HotDocs Server features to callers. If you need a host application to run on a different machine (or a different platform) than HotDocs Server, you can choose to install and use the web services API, and then design your host application to access HotDocs via this REST interface.

Documentation

For full documentation of the HotDocs Web Service, see the HotDocs Web Service Help.

Prerequisites

Before you start the examples, you must:

• Install HotDocs Server – provides document assembly using HotDocs templates.
• Install HotDocs Server Management Tools – provides tools to configure HotDocs Server.
• Install the HotDocs Web Service – the HotDocs on-premise web service.

Example Projects

All of the examples projects below are available to download from the HotDocs-Samples repository on GitHub.

• WebServiceExample1Upload – upload a Template Package File to the Web Service
• WebServiceExample2DocumentAssembly – assemble a document using the Web Service
• WebServiceExample3InterviewDisplay – display an interview to the user in a web page
• WebServiceExample4ComponentInfo – get dialog and variable information from the uploaded Template Package File
• WebServiceExample5InterviewFile – get a specific file from the uploaded Template Package File

Examples Walkthrough

To assist in developing custom web application using HotDocs Server and the HotDocs Web Service, there are example tutorials that explain different Web Service and HotDocs Server features. Each example covers different functionality an application will typically implement:

• Web Service Example 1: Upload a HotDocs Template
• Web ServiceExample 2: Assemble a Document
• Web Service Example 3: Display the HotDocs Interview
• Web Service Example 4: Get Component File Information
• Web Service Example 5: Get Interview File