HotDocs Advance API Reference Documentation

You can view the latest reference documentation for the Advance API at https://yourorganization.com/HdaApi/rest/documentation/index.html, where yourorganization.com is the domain under which your Advance deployment is located.

You can view the latest documentation for the Advance API at http://hotdocsadvance.com/api/rest/documentation/index.html

The reference documentation contains details of all public API methods. For selected examples of using the API, see Using the API Overview.

Answer Set Schemas

Some HotDocs Advance API methods may require you to send a HotDocs Answer Set with the request. The answer set must be validated against the HotDocs Answer Set schema before the request is sent.

API Resources

When making an HTTP request, the following resources are available in the Advance API.

See also: Advance concepts for API users.

Resource Description Related Tasks

TemplatePackages

 A template package is a zipped package of files sent to Advance when a template is uploaded from HotDocs Author. The template package contains the template files and associated metadata files. The template You can:
  • select whether the template is active

TemplatePackageVersions

 When you upload a zipped template package from Author, Advance creates a new version of the template. Before users can assemble a document, a template must have a live version. You can:
  • forward publish by setting the date and time from which a template version is accessible to users
  • get a template's variable data

UserGroups

 A user group is a collection of user accounts, used to control access to work groups. Users can only access a work group if they are included in a user group that is allocated to that work group. You can:
  • make user groups active
  • add users to a group

Users

 A user account within Advance. Users may have additional administrative roles, which provide them with authorization to perform specific actions in Advance. You can:  

WorkGroups

 A work group is a named location in which users can create work items. Users can only create work items in a work group if they are included in a user group that is allocated to that work group. Work groups are used to control access to template packages; users can only access template packages which have been allocated to their work group.   You can:
  • make a work group active
  • allocate user groups to a work group
  • assign templates to a work group
  • get a list of the work items in a group

WorkItems

 A work item is a named entity in HotDocs Advance with which you can enter and edit answer data, and assemble documents from that data, for a specific template package. Users create work items through their allocated work groups. By default, work items are accessible to any user that has access to the work group. You can make work items private, so that only the user that created the work item can access it.

 

 You can:

AnswerFile

 An answer file is XML that comprises an answer set. When creating a work item using the API, you can optionally supply an XML string in the request. Advance can then assemble documents for the work item using the supplied answer file. You can:
  • download a work item's answer file
 

AssemblySessions/Versions

 An assembly session is a specific instance of the document assembly process in the Core Assembly Service. Using assembly sessions, you can manage the creation of new versions of a work item and assemble documents. In-progress assembly sessions can be saved or completed. When a user completes an assembly session, Advance creates a new version of the work item, with a new set of assembled documents. You can:

Documents

 The assembled documents created by processing an answer file and template package in an assembly session. You can:
  • download assembled documents