IHDSvc.GetInterview Method

IHDSvc GetInterview Method

Returns an HTML fragment containing the HotDocs interview for a given template. This fragment is suitable for insertion anywhere in the <body> element of an HTML page, and it takes care of loading all necessary external resources (scripts, css files, etc.).

See HotDocs Server help file for browser requirements for the different types of interviews.

Silverlight interviews are suitable for insertion into most web pages (both standards-compliant and "quirks" mode), while JavaScript interviews currently require quirks mode on Internet Explorer 6 and later.

Caller can omit:

saveAnswersUrl to disable save answers button.
previewUrl to disable document previews.
interviewDefinitionUrl is required for Silverlight interviews and ignored for JavaScript interviews.

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[] GetInterview(
	string templateID,
	BinaryObject[] answers,
	InterviewFormat format,
	InterviewOptions options,
	string[] markedVariables,
	string formActionUrl,
	string serverFilesUrl,
	string styleUrl,
	string tempInterviewUrl,
	string saveAnswersUrl,
	string previewUrl,
	string interviewDefinitionUrl
)

BinaryObject[] GetInterview(
	string templateID,
	BinaryObject[] answers,
	InterviewFormat format,
	InterviewOptions options,
	string[] markedVariables,
	string formActionUrl,
	string serverFilesUrl,
	string styleUrl,
	string tempInterviewUrl,
	string saveAnswersUrl,
	string previewUrl,
	string interviewDefinitionUrl
)

Parameters

templateID: Type: System String
The file name of the template.

answers: Type: HotDocs.Sdk.Server.Contracts BinaryObject
List of answer collections to be overlaid successively and used to pre-populate the interview. 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 InterviewFormat
A value from the InterviewFormat enumeration, indicating whether you are requesting a Silverlight or JavaScript interview.

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

markedVariables: Type: System String
An array of variable names that should be "marked" or highlighted in the interview. Typically used to highlight unanswered variables when returning to a previously-submitted interview.

formActionUrl: Type: System String
The URL to which interview results will be posted when the user clicks "Finish". Sometimes referred to as the "disposition page."

serverFilesUrl: Type: System String
The base URL from which the HotDocs Server JavaScript files will be requested.

styleUrl: Type: System String
The URL of the user CSS file to be used. Note that the hdssystem.css style sheet must also be available in the same directory. Also, for Silverlight interviews, a .xaml style sheet with the same base file name and in the same directory will also be loaded.

tempInterviewUrl: Type: System String
The base URL from which this interview's custom images will be requested. It is the caller's responsibility to make any images returned from this web service available at this base URL (to which the appropriate file name will be appended).

saveAnswersUrl: Type: System String
The URL to which requests to save answers will be posted (null to disable save answers).

previewUrl: Type: System String
The URL to which requests for document previews will be posted (null to disable preview). (todo: document URL format)

interviewDefinitionUrl: Type: System String
The URL from which the interview will request compiled Silverlight interview DLLs (required for Silverlight interviews). (todo: document URL fromat)

Return Value

Type: BinaryObject
Returns a BinaryObject array. The first object in this array is the HTML code that defines the HotDocs interview. Additional objects in the array, if any, are other files used by the interview, such as images referred to by various dialog elements.