IHDSvc.AssembleDocument Method

IHDSvc AssembleDocument Method

This web service assembles a template using the provided answers.

Namespace: HotDocs.Sdk.Server.Contracts
Assembly: HotDocs.Sdk.Server.Contracts (in HotDocs.Sdk.Server.Contracts.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy to Clipboard Print

AssemblyResult AssembleDocument(
	string templateID,
	BinaryObject[] answers,
	OutputFormat format,
	AssemblyOptions options,
	string templateState
)

AssemblyResult AssembleDocument(
	string templateID,
	BinaryObject[] answers,
	OutputFormat format,
	AssemblyOptions options,
	string templateState
)

Parameters

templateID: Type: System String
The file name (not including the path) of the template to assemble.

answers: Type: HotDocs.Sdk.Server.Contracts BinaryObject
An array of answer collections to be used to assemble the document. If more than one answer collection is included, they are successively overlaid on top of each other before assembly. Each element in this array can be either an XML answer collection or an encoded answer set as posted from a browser interview.

format: Type: HotDocs.Sdk.Server.Contracts OutputFormat
This parameter determines the document format(s) to be delivered. It can be one or more compatible values from the OutputFormat enumeration.

options: Type: HotDocs.Sdk.Server.Contracts AssemblyOptions
One or more compatible values from the AssemblyOptions enumeration.

templateState: Type: System String
This parameter is either null if the template is located in the web service's default template directory (as specified in web.config), or it is an encrypted value encapsulating the location of the template.

Return Value

Type: AssemblyResult
An AssemblyResult object containing the assembled document in the requested output format(s), the resulting answer file (if requested), and information about unanswered variables and the assembly queue.

Remarks

For many template types, HotDocs Server supports multiple output formats, and you can use one call to this web service to receive the same document in multiple formats.