Docusign CSharp Docs
Classes | Enumerations
DocuSign.WebForms.Model Namespace Reference

Classes

class  CreateInstanceRequestBody
 Request body containing properties that will be used to create instance. More...
 
class  HttpError
 An error occurred while processing a request. Source - https://www.baeldung.com/rest-api-error-handling-best-practices More...
 
class  HttpSuccess
 A simple response indicating success when no extra data is needed More...
 
class  Tags
 List of tags provided by the user with each request. This field is optional. More...
 
class  TemplateProperties
 Information about a DocuSign template that will be used to seed a web form. More...
 
class  UpdateInstanceRequestBody
 Request body containing properties that needs to be updated. More...
 
class  WebForm
 An object that fully describes an instance of a form More...
 
class  WebFormComponent
 Each component type contains additional properties More...
 
class  WebFormComponentsMap
 The components map for the web form More...
 
class  WebFormContent
 Container for the components map used during configuration and data collection More...
 
class  WebFormInstance
 An object that contains the Web Form Instance required to render it and its metadata such as created by, created time More...
 
class  WebFormInstanceEnvelopes
 WebFormInstanceEnvelopes More...
 
class  WebFormInstanceList
 A list of web form instance items. More...
 
class  WebFormInstanceMetadata
 Web Form Instance metadata containing information like created by, created time, etc. More...
 
class  WebFormMetadata
 Form metadata More...
 
class  WebFormProperties
 General information about the web form that is consistent across versions More...
 
class  WebFormPublishedNames
 A collection of the published component name and its corresponding type More...
 
class  WebFormSummary
 An object that summarizes an instance of a form that can be used to display a listing More...
 
class  WebFormSummaryList
 A list of web form summary items. More...
 
class  WebFormUserInfo
 Information about a DocuSign system user. The user exists within the account associated with the form. More...
 
class  WebFormValues
 Key-value pairs (where key is the component name and value is the form value) used to create a form instance. For key of type TextBox, Email, Date, Select and RadioButtonGroup the value is of string type. For key of type Number, the value is of number type. For key of type of CheckboxGroup, the value is of type array of string. More...
 

Enumerations

enum  AuthenticationMethod {
  AuthenticationMethod.Biometric = 1, AuthenticationMethod.Email = 2, AuthenticationMethod.HTTPBasicAuth = 3, AuthenticationMethod.Kerberos = 4,
  AuthenticationMethod.KnowledgeBasedAuth = 5, AuthenticationMethod.None = 6, AuthenticationMethod.PaperDocuments = 7, AuthenticationMethod.Password = 8,
  AuthenticationMethod.RSASecureID = 9, AuthenticationMethod.SingleSignOnCASiteminder = 10, AuthenticationMethod.SingleSignOnInfoCard = 11, AuthenticationMethod.SingleSignOnMicrosoftActiveDirectory = 12,
  AuthenticationMethod.SingleSignOnOther = 13, AuthenticationMethod.SingleSignOnPassport = 14, AuthenticationMethod.SingleSignOnSAML = 15, AuthenticationMethod.Smartcard = 16,
  AuthenticationMethod.SSLMutualAuth = 17, AuthenticationMethod.X509Certificate = 18
}
 A value that most closely matches the technique your application used to authenticate the recipient / signer. More...
 
enum  InstanceSource {
  InstanceSource.PUBLICURL = 1, InstanceSource.APIEMBEDDED = 2, InstanceSource.APIREMOTE = 3, InstanceSource.UIREMOTE = 4,
  InstanceSource.WORKFLOW = 5
}
 The method through which form instance is created. More...
 
enum  InstanceStatus {
  InstanceStatus.INITIATED = 1, InstanceStatus.INPROGRESS = 2, InstanceStatus.SUBMITTED = 3, InstanceStatus.EXPIRED = 4,
  InstanceStatus.FAILED = 5
}
 The status of Web Form Instance. If the form status is INITIATED, it means the form is accessible until it is submitted or expired. If the form status is SUBMITTED, it means the form is submitted already and hence, cannot be opened again. More...
 
enum  Source { Source.PUBLICURL = 1, Source.APIEMBEDDED = 2, Source.APIREMOTE = 3, Source.UIREMOTE = 4 }
 The method through which form instance is created. More...
 
enum  UserFilter { UserFilter.Ownedbyme = 1, UserFilter.Sharedwithme = 2, UserFilter.All = 3 }
 Filter which forms are returned More...
 
enum  WebFormAdmType {
  WebFormAdmType.String = 1, WebFormAdmType.Boolean = 2, WebFormAdmType.Double = 3, WebFormAdmType.DateTime = 4,
  WebFormAdmType.ArrayOfString = 5, WebFormAdmType.CheckboxGroup = 6, WebFormAdmType.Date = 7, WebFormAdmType.Email = 8,
  WebFormAdmType.Number = 9, WebFormAdmType.RadioButtonGroup = 10, WebFormAdmType.Select = 11, WebFormAdmType.TextBox = 12
}
 Type used at ADM model as ComponentType decorator. "String", "Boolean", "Double", "DateTime", ArrayOfString" are deprecated. More...
 
enum  WebFormComponentType {
  WebFormComponentType.CheckboxGroup = 1, WebFormComponentType.Date = 2, WebFormComponentType.Email = 3, WebFormComponentType.Number = 4,
  WebFormComponentType.RadioButtonGroup = 5, WebFormComponentType.Select = 6, WebFormComponentType.TextBox = 7
}
 Type of components used in the web form More...
 
enum  WebFormSource { WebFormSource.Templates = 1, WebFormSource.Blank = 2, WebFormSource.Form = 3 }
 The source from which the web form is created. More...
 
enum  WebFormState { WebFormState.Active = 1, WebFormState.Draft = 2 }
 The state of the form content More...
 
enum  WebFormType { WebFormType.Standalone = 1, WebFormType.HasEsignTemplate = 2 }
 The field indicates webform type. More...
 

Enumeration Type Documentation

◆ AuthenticationMethod

A value that most closely matches the technique your application used to authenticate the recipient / signer.

A value that most closely matches the technique your application used to authenticate the recipient / signer.

Enumerator
Biometric 

Enum Biometric for value: Biometric

Email 

Enum Email for value: Email

HTTPBasicAuth 

Enum HTTPBasicAuth for value: HTTPBasicAuth

Kerberos 

Enum Kerberos for value: Kerberos

KnowledgeBasedAuth 

Enum KnowledgeBasedAuth for value: KnowledgeBasedAuth

None 

Enum None for value: None

PaperDocuments 

Enum PaperDocuments for value: PaperDocuments

Password 

Enum Password for value: Password

RSASecureID 

Enum RSASecureID for value: RSASecureID

SingleSignOnCASiteminder 

Enum SingleSignOnCASiteminder for value: SingleSignOn_CASiteminder

SingleSignOnInfoCard 

Enum SingleSignOnInfoCard for value: SingleSignOn_InfoCard

SingleSignOnMicrosoftActiveDirectory 

Enum SingleSignOnMicrosoftActiveDirectory for value: SingleSignOn_MicrosoftActiveDirectory

SingleSignOnOther 

Enum SingleSignOnOther for value: SingleSignOn_Other

SingleSignOnPassport 

Enum SingleSignOnPassport for value: SingleSignOn_Passport

SingleSignOnSAML 

Enum SingleSignOnSAML for value: SingleSignOn_SAML

Smartcard 

Enum Smartcard for value: Smartcard

SSLMutualAuth 

Enum SSLMutualAuth for value: SSLMutualAuth

X509Certificate 

Enum X509Certificate for value: X509Certificate

◆ InstanceSource

The method through which form instance is created.

The method through which form instance is created.

Enumerator
PUBLICURL 

Enum PUBLICURL for value: PUBLIC_URL

APIEMBEDDED 

Enum APIEMBEDDED for value: API_EMBEDDED

APIREMOTE 

Enum APIREMOTE for value: API_REMOTE

UIREMOTE 

Enum UIREMOTE for value: UI_REMOTE

WORKFLOW 

Enum WORKFLOW for value: WORKFLOW

◆ InstanceStatus

The status of Web Form Instance. If the form status is INITIATED, it means the form is accessible until it is submitted or expired. If the form status is SUBMITTED, it means the form is submitted already and hence, cannot be opened again.

The status of Web Form Instance. If the form status is INITIATED, it means the form is accessible until it is submitted or expired. If the form status is SUBMITTED, it means the form is submitted already and hence, cannot be opened again.

Enumerator
INITIATED 

Enum INITIATED for value: INITIATED

INPROGRESS 

Enum INPROGRESS for value: IN_PROGRESS

SUBMITTED 

Enum SUBMITTED for value: SUBMITTED

EXPIRED 

Enum EXPIRED for value: EXPIRED

FAILED 

Enum FAILED for value: FAILED

◆ Source

The method through which form instance is created.

The method through which form instance is created.

Enumerator
PUBLICURL 

Enum PUBLICURL for value: PUBLIC_URL

APIEMBEDDED 

Enum APIEMBEDDED for value: API_EMBEDDED

APIREMOTE 

Enum APIREMOTE for value: API_REMOTE

UIREMOTE 

Enum UIREMOTE for value: UI_REMOTE

◆ UserFilter

Filter which forms are returned

Filter which forms are returned

Enumerator
Ownedbyme 

Enum Ownedbyme for value: owned_by_me

Sharedwithme 

Enum Sharedwithme for value: shared_with_me

All 

Enum All for value: all

◆ WebFormAdmType

Type used at ADM model as ComponentType decorator. "String", "Boolean", "Double", "DateTime", ArrayOfString" are deprecated.

Type used at ADM model as ComponentType decorator. "String", "Boolean", "Double", "DateTime", ArrayOfString" are deprecated.

Enumerator
String 

Enum String for value: String

Boolean 

Enum Boolean for value: Boolean

Double 

Enum Double for value: Double

DateTime 

Enum DateTime for value: DateTime

ArrayOfString 

Enum ArrayOfString for value: ArrayOfString

CheckboxGroup 

Enum CheckboxGroup for value: CheckboxGroup

Date 

Enum Date for value: Date

Email 

Enum Email for value: Email

Number 

Enum Number for value: Number

RadioButtonGroup 

Enum RadioButtonGroup for value: RadioButtonGroup

Select 

Enum Select for value: Select

TextBox 

Enum TextBox for value: TextBox

◆ WebFormComponentType

Type of components used in the web form

Type of components used in the web form

Enumerator
CheckboxGroup 

Enum CheckboxGroup for value: CheckboxGroup

Date 

Enum Date for value: Date

Email 

Enum Email for value: Email

Number 

Enum Number for value: Number

RadioButtonGroup 

Enum RadioButtonGroup for value: RadioButtonGroup

Select 

Enum Select for value: Select

TextBox 

Enum TextBox for value: TextBox

◆ WebFormSource

The source from which the web form is created.

The source from which the web form is created.

Enumerator
Templates 

Enum Templates for value: templates

Blank 

Enum Blank for value: blank

Form 

Enum Form for value: form

◆ WebFormState

The state of the form content

The state of the form content

Enumerator
Active 

Enum Active for value: active

Draft 

Enum Draft for value: draft

◆ WebFormType

The field indicates webform type.

The field indicates webform type.

Enumerator
Standalone 

Enum Standalone for value: standalone

HasEsignTemplate 

Enum HasEsignTemplate for value: hasEsignTemplate