ICore.GetComponentInfo Method

ICore GetComponentInfo Method

This web service retrieves metadata about variables and optionally dialog structure. The variable information is essentially the same as what is found in the .HVC file created when you publish a template for use with HotDocs Server, and the dialog information is a list of the dialog's variables and any answer source mappings that may exist for the dialog.

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

ComponentInfo GetComponentInfo(
	string subscriberID,
	string packageID,
	string templateName,
	bool includeDialogs,
	string billingRef,
	DateTime timestamp,
	BinaryObject templatePackage,
	string hmac
)

ComponentInfo GetComponentInfo(
	string subscriberID,
	string packageID,
	string templateName,
	bool includeDialogs,
	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
The file name of the template.

includeDialogs: Type: System Boolean
This indicates whether or not the returned data should include information about dialogs and their contents.

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.GetComponentInfo(System.String,System.String,System.String,System.Boolean,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: ComponentInfo
A ComponentInfo object with information about each variable (and optionally dialog) in the template's interview.