ICore.AssembleDocument Method

ICore AssembleDocument Method

[Missing <summary> documentation for "M:HotDocs.Sdk.Server.Contracts.ICore.AssembleDocument(System.String,System.String,System.String,HotDocs.Sdk.Server.Contracts.BinaryObject[],HotDocs.Sdk.Server.Contracts.OutputFormat,HotDocs.Sdk.Server.Contracts.OutputOptions,System.Collections.Generic.Dictionary{System.String,System.String},System.String,System.DateTime,HotDocs.Sdk.Server.Contracts.BinaryObject,System.String)"]

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 subscriberID,
	string packageID,
	string templateName,
	BinaryObject[] answers,
	OutputFormat format,
	OutputOptions outputOptions,
	Dictionary<string, string> settings,
	string billingRef,
	DateTime timestamp,
	BinaryObject templatePackage,
	string hmac
)

AssemblyResult AssembleDocument(
	string subscriberID,
	string packageID,
	string templateName,
	BinaryObject[] answers,
	OutputFormat format,
	OutputOptions outputOptions,
	Dictionary<string, string> settings,
	string billingRef,
	DateTime timestamp,
	BinaryObject templatePackage,
	string hmac
)

Parameters

subscriberID: Type: System String
The Subscriber account identifier, found in the Administration Portal. The subscriber ID corresponds to the company or website subscribing to the service, not an individual end user.

packageID: Type: System String
A unique identifier for the template package in which the desired template is found. Although you could use any string value that uniquely identifies the package, a GUID is recommended since every template package (including new versions of existing template packages) must have a unique ID. (If you create a new package but use the same ID as an existing package, HotDocs Core Services may continue using the old package if it is still in its cache.)

templateName: Type: System String
[Missing <param name="templateName"/> documentation for "M:HotDocs.Sdk.Server.Contracts.ICore.AssembleDocument(System.String,System.String,System.String,HotDocs.Sdk.Server.Contracts.BinaryObject[],HotDocs.Sdk.Server.Contracts.OutputFormat,HotDocs.Sdk.Server.Contracts.OutputOptions,System.Collections.Generic.Dictionary{System.String,System.String},System.String,System.DateTime,HotDocs.Sdk.Server.Contracts.BinaryObject,System.String)"]

answers: Type: HotDocs.Sdk.Server.Contracts BinaryObject
[Missing <param name="answers"/> documentation for "M:HotDocs.Sdk.Server.Contracts.ICore.AssembleDocument(System.String,System.String,System.String,HotDocs.Sdk.Server.Contracts.BinaryObject[],HotDocs.Sdk.Server.Contracts.OutputFormat,HotDocs.Sdk.Server.Contracts.OutputOptions,System.Collections.Generic.Dictionary{System.String,System.String},System.String,System.DateTime,HotDocs.Sdk.Server.Contracts.BinaryObject,System.String)"]

format: Type: HotDocs.Sdk.Server.Contracts OutputFormat
[Missing <param name="format"/> documentation for "M:HotDocs.Sdk.Server.Contracts.ICore.AssembleDocument(System.String,System.String,System.String,HotDocs.Sdk.Server.Contracts.BinaryObject[],HotDocs.Sdk.Server.Contracts.OutputFormat,HotDocs.Sdk.Server.Contracts.OutputOptions,System.Collections.Generic.Dictionary{System.String,System.String},System.String,System.DateTime,HotDocs.Sdk.Server.Contracts.BinaryObject,System.String)"]

outputOptions: Type: HotDocs.Sdk.Server.Contracts OutputOptions
[Missing <param name="outputOptions"/> documentation for "M:HotDocs.Sdk.Server.Contracts.ICore.AssembleDocument(System.String,System.String,System.String,HotDocs.Sdk.Server.Contracts.BinaryObject[],HotDocs.Sdk.Server.Contracts.OutputFormat,HotDocs.Sdk.Server.Contracts.OutputOptions,System.Collections.Generic.Dictionary{System.String,System.String},System.String,System.DateTime,HotDocs.Sdk.Server.Contracts.BinaryObject,System.String)"]

settings: Type: System.Collections.Generic Dictionary String, String
[Missing <param name="settings"/> documentation for "M:HotDocs.Sdk.Server.Contracts.ICore.AssembleDocument(System.String,System.String,System.String,HotDocs.Sdk.Server.Contracts.BinaryObject[],HotDocs.Sdk.Server.Contracts.OutputFormat,HotDocs.Sdk.Server.Contracts.OutputOptions,System.Collections.Generic.Dictionary{System.String,System.String},System.String,System.DateTime,HotDocs.Sdk.Server.Contracts.BinaryObject,System.String)"]

billingRef: Type: System String
This parameter lets you specify information that will be included in usage logs for this call. For example, you can use a string to uniquely identify the end user that initiated the request and/or the context in which the call was made. When you review usage logs, you can then see which end users initiated each request. That information could then be used to pass costs on to those end users if desired.

timestamp: Type: System DateTime
This is the time (in UTC) when the call is being made. If it is more than 15 minutes different than the HotDocs Core Services service's time, the request will fail. This is useful for synchronizing time stamps between servers and for security purposes to limit play-back attempts.

templatePackage: Type: HotDocs.Sdk.Server.Contracts BinaryObject
[Missing <param name="templatePackage"/> documentation for "M:HotDocs.Sdk.Server.Contracts.ICore.AssembleDocument(System.String,System.String,System.String,HotDocs.Sdk.Server.Contracts.BinaryObject[],HotDocs.Sdk.Server.Contracts.OutputFormat,HotDocs.Sdk.Server.Contracts.OutputOptions,System.Collections.Generic.Dictionary{System.String,System.String},System.String,System.DateTime,HotDocs.Sdk.Server.Contracts.BinaryObject,System.String)"]

hmac: Type: System String
This is a hash key used to authenticate the request made to HotDocs Core Services.

Return Value

Type: AssemblyResult

[Missing <returns> documentation for "M:HotDocs.Sdk.Server.Contracts.ICore.AssembleDocument(System.String,System.String,System.String,HotDocs.Sdk.Server.Contracts.BinaryObject[],HotDocs.Sdk.Server.Contracts.OutputFormat,HotDocs.Sdk.Server.Contracts.OutputOptions,System.Collections.Generic.Dictionary{System.String,System.String},System.String,System.DateTime,HotDocs.Sdk.Server.Contracts.BinaryObject,System.String)"]