RestClient.UploadPackage Method (String, String, String)

RestClient UploadPackage Method (String, String, String)

Uploads a package to HotDocs Cloud Services from the specified file path.

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

Syntax

public void UploadPackage(
	string packageID,
	string billingRef,
	string packageFile
)

public void UploadPackage(
	string packageID,
	string billingRef,
	string packageFile
)

Parameters

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.)

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.

packageFile: Type: System String
The file path of the package to be uploaded.

Remarks

This call throws an exception if the package is already cached in Cloud Services. The point of the exception is to discourage consumers from constantly re-uploading the same package. Consumers should upload a package only if: 1) They have already attempted their request and received a "package not found" error. or 2) They happen to know that the package is not already cached, e.g. the package is new.