RestClient.CreateSession Method

RestClient CreateSession Method

Creates a new session for assembling documents using the HotDocs Cloud Services Rest API.

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

Syntax

public string CreateSession(
	Template template,
	string billingRef = null,
	string answers = null,
	string[] markedVariables = null,
	InterviewFormat interviewFormat = InterviewFormat.JavaScript,
	OutputFormat outputFormat = OutputFormat.Native,
	Dictionary<string, string> settings = null,
	string theme = null,
	bool showDownloadLinks = true
)

public string CreateSession(
	Template template,
	string billingRef = null,
	string answers = null,
	string[] markedVariables = null,
	InterviewFormat interviewFormat = InterviewFormat.JavaScript,
	OutputFormat outputFormat = OutputFormat.Native,
	Dictionary<string, string> settings = null,
	string theme = null,
	bool showDownloadLinks = true
)

Parameters

template: Type: HotDocs.Sdk Template
The template to use with the session.

billingRef (Optional): 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.

answers (Optional): Type: System String
The answers to use.

markedVariables (Optional): Type: System String
An array of variable names, whose prompts should be "marked" when displayed in an interview.

interviewFormat (Optional): Type: HotDocs.Sdk.Server.Contracts InterviewFormat
The format to use when displaying an interview.

outputFormat (Optional): Type: HotDocs.Sdk.Server.Contracts OutputFormat
The format to use when assembling a document.

settings (Optional): Type: System.Collections.Generic Dictionary String, String
The settings to use with the session.

theme (Optional): Type: System String
The interview theme.

showDownloadLinks (Optional): Type: System Boolean
Indicates whether or not links for downloading the assembled document(s) should appear at the end of the interview.

Return Value

Type:

String

[Missing <returns> documentation for "M:HotDocs.Sdk.Cloud.RestClient.CreateSession(HotDocs.Sdk.Template,System.String,System.String,System.String[],HotDocs.Sdk.Server.Contracts.InterviewFormat,HotDocs.Sdk.Server.Contracts.OutputFormat,System.Collections.Generic.Dictionary{System.String,System.String},System.String,System.Boolean)"]