IHDSvc.GetInterviewDefinition Method

IHDSvc GetInterviewDefinition Method

This web service returns an interview definition file for the specified template.

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

BinaryObject GetInterviewDefinition(
	string templateID,
	string templateName,
	InterviewFormat format,
	string templateState
)

BinaryObject GetInterviewDefinition(
	string templateID,
	string templateName,
	InterviewFormat format,
	string templateState
)

Parameters

templateID: Type: System String
The file name and extension for the template. Caller should pass templateID or a templateState, but not both.

templateName: Type: System String
The name of the template whose interview definition is being requested. Unnecessary if you have specified templateID.

format: Type: HotDocs.Sdk.Server.Contracts InterviewFormat
Indicates the format whether to request a Silverlight or JavaScript interview definition. The only format currently supported is Silverlight, which means this web service will return a compiled Silverlight interview DLL.

templateState: Type: System String
An encrypted string (originating from a browser interview) identifying a template. Caller should pass templateID or templateState, but not both.

Return Value

Type: BinaryObject
A BinaryObject with the requested interview definition.

Remarks

This is necessary to facilitate Silverlight interviews working over web services. Callers must specify EITHER a templateID (which refers to a template file in the default template directory) OR a templateName and templateState.