Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for DocuSign.eSign.Api.IPowerFormsApi:

Public Member Functions
PowerForm	CreatePowerForm (string accountId, PowerForm powerForm=null)
	Creates a new PowerForm. More...

ApiResponse< PowerForm >	CreatePowerFormWithHttpInfo (string accountId, PowerForm powerForm=null)
	Creates a new PowerForm. More...

void	DeletePowerForm (string accountId, string powerFormId)
	Delete a PowerForm. More...

ApiResponse< Object >	DeletePowerFormWithHttpInfo (string accountId, string powerFormId)
	Delete a PowerForm. More...

PowerFormsResponse	DeletePowerForms (string accountId, PowerFormsRequest powerFormsRequest=null)
	Deletes one or more PowerForms More...

ApiResponse< PowerFormsResponse >	DeletePowerFormsWithHttpInfo (string accountId, PowerFormsRequest powerFormsRequest=null)
	Deletes one or more PowerForms More...

PowerForm	GetPowerForm (string accountId, string powerFormId)
	Returns a single PowerForm. More...

ApiResponse< PowerForm >	GetPowerFormWithHttpInfo (string accountId, string powerFormId)
	Returns a single PowerForm. More...

PowerFormsFormDataResponse	GetPowerFormData (string accountId, string powerFormId, PowerFormsApi.GetPowerFormDataOptions options=null)
	Returns the form data associated with the usage of a PowerForm. More...

ApiResponse< PowerFormsFormDataResponse >	GetPowerFormDataWithHttpInfo (string accountId, string powerFormId, PowerFormsApi.GetPowerFormDataOptions options=null)
	Returns the form data associated with the usage of a PowerForm. More...

PowerFormSendersResponse	ListPowerFormSenders (string accountId, PowerFormsApi.ListPowerFormSendersOptions options=null)
	Returns the list of PowerForms available to the user. More...

ApiResponse< PowerFormSendersResponse >	ListPowerFormSendersWithHttpInfo (string accountId, PowerFormsApi.ListPowerFormSendersOptions options=null)
	Returns the list of PowerForms available to the user. More...

PowerFormsResponse	ListPowerForms (string accountId, PowerFormsApi.ListPowerFormsOptions options=null)
	Returns the list of PowerForms available to the user. More...

ApiResponse< PowerFormsResponse >	ListPowerFormsWithHttpInfo (string accountId, PowerFormsApi.ListPowerFormsOptions options=null)
	Returns the list of PowerForms available to the user. More...

PowerForm	UpdatePowerForm (string accountId, string powerFormId, PowerForm powerForm=null)
	Creates a new PowerForm. More...

ApiResponse< PowerForm >	UpdatePowerFormWithHttpInfo (string accountId, string powerFormId, PowerForm powerForm=null)
	Creates a new PowerForm. More...

System.Threading.Tasks.Task< PowerForm >	CreatePowerFormAsync (string accountId, PowerForm powerForm=null)
	Creates a new PowerForm. More...

System.Threading.Tasks.Task< ApiResponse< PowerForm > >	CreatePowerFormAsyncWithHttpInfo (string accountId, PowerForm powerForm=null)
	Creates a new PowerForm. More...

System.Threading.Tasks.Task	DeletePowerFormAsync (string accountId, string powerFormId)
	Delete a PowerForm. More...

System.Threading.Tasks.Task< ApiResponse< Object > >	DeletePowerFormAsyncWithHttpInfo (string accountId, string powerFormId)
	Delete a PowerForm. More...

System.Threading.Tasks.Task< PowerFormsResponse >	DeletePowerFormsAsync (string accountId, PowerFormsRequest powerFormsRequest=null)
	Deletes one or more PowerForms More...

System.Threading.Tasks.Task< ApiResponse< PowerFormsResponse > >	DeletePowerFormsAsyncWithHttpInfo (string accountId, PowerFormsRequest powerFormsRequest=null)
	Deletes one or more PowerForms More...

System.Threading.Tasks.Task< PowerForm >	GetPowerFormAsync (string accountId, string powerFormId)
	Returns a single PowerForm. More...

System.Threading.Tasks.Task< ApiResponse< PowerForm > >	GetPowerFormAsyncWithHttpInfo (string accountId, string powerFormId)
	Returns a single PowerForm. More...

System.Threading.Tasks.Task< PowerFormsFormDataResponse >	GetPowerFormDataAsync (string accountId, string powerFormId, PowerFormsApi.GetPowerFormDataOptions options=null)
	Returns the form data associated with the usage of a PowerForm. More...

System.Threading.Tasks.Task< ApiResponse< PowerFormsFormDataResponse > >	GetPowerFormDataAsyncWithHttpInfo (string accountId, string powerFormId, PowerFormsApi.GetPowerFormDataOptions options=null)
	Returns the form data associated with the usage of a PowerForm. More...

System.Threading.Tasks.Task< PowerFormSendersResponse >	ListPowerFormSendersAsync (string accountId, PowerFormsApi.ListPowerFormSendersOptions options=null)
	Returns the list of PowerForms available to the user. More...

System.Threading.Tasks.Task< ApiResponse< PowerFormSendersResponse > >	ListPowerFormSendersAsyncWithHttpInfo (string accountId, PowerFormsApi.ListPowerFormSendersOptions options=null)
	Returns the list of PowerForms available to the user. More...

System.Threading.Tasks.Task< PowerFormsResponse >	ListPowerFormsAsync (string accountId, PowerFormsApi.ListPowerFormsOptions options=null)
	Returns the list of PowerForms available to the user. More...

System.Threading.Tasks.Task< ApiResponse< PowerFormsResponse > >	ListPowerFormsAsyncWithHttpInfo (string accountId, PowerFormsApi.ListPowerFormsOptions options=null)
	Returns the list of PowerForms available to the user. More...

System.Threading.Tasks.Task< PowerForm >	UpdatePowerFormAsync (string accountId, string powerFormId, PowerForm powerForm=null)
	Creates a new PowerForm. More...

System.Threading.Tasks.Task< ApiResponse< PowerForm > >	UpdatePowerFormAsyncWithHttpInfo (string accountId, string powerFormId, PowerForm powerForm=null)
	Creates a new PowerForm. More...

Public Member Functions inherited from DocuSign.eSign.Client.IApiAccessor
String	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from DocuSign.eSign.Client.IApiAccessor
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreatePowerForm()

PowerForm DocuSign.eSign.Api.IPowerFormsApi.CreatePowerForm	(	string	accountId,
		PowerForm	powerForm = `null`
	)

Creates a new PowerForm.

This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, based on the `templateId` in the request body. PowerForms that you create from a template are referred to as web PowerForms. Note: The DocuSign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a PDF PowerForm). However, PDF PowerForms are deprecated and are not supported in the API. Note: A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm initiator.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm. ### Signing modes You can use one of the following signing modes for a PowerForm: `email` This mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks Begin Signing to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document. Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code. Example: `activateonly=1` `direct` This mode does not require any verification. After a recipient enters their email address on the landing page and clicks Begin Signing, a new browser tab opens and the recipient can immediately begin the signing process. Because the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). Note: In the account settings, `enablePowerFormDirect` must be true to use `direct` as the `signingMode`. ### Redirect URLs You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see How do I specify a URL to redirect to when a PowerForm is completed?. ### More information For more information about creating PowerForms, see Create a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerForm	(optional)

Returns

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ CreatePowerFormAsync()

System.Threading.Tasks.Task<PowerForm> DocuSign.eSign.Api.IPowerFormsApi.CreatePowerFormAsync	(	string	accountId,
		PowerForm	powerForm = `null`
	)

Creates a new PowerForm.

This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, based on the `templateId` in the request body. PowerForms that you create from a template are referred to as web PowerForms. Note: The DocuSign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a PDF PowerForm). However, PDF PowerForms are deprecated and are not supported in the API. Note: A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm initiator.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm. ### Signing modes You can use one of the following signing modes for a PowerForm: `email` This mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks Begin Signing to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document. Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code. Example: `activateonly=1` `direct` This mode does not require any verification. After a recipient enters their email address on the landing page and clicks Begin Signing, a new browser tab opens and the recipient can immediately begin the signing process. Because the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). Note: In the account settings, `enablePowerFormDirect` must be true to use `direct` as the `signingMode`. ### Redirect URLs You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see How do I specify a URL to redirect to when a PowerForm is completed?. ### More information For more information about creating PowerForms, see Create a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerForm	(optional)

Returns: Task of PowerForm

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ CreatePowerFormAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<PowerForm> > DocuSign.eSign.Api.IPowerFormsApi.CreatePowerFormAsyncWithHttpInfo	(	string	accountId,
		PowerForm	powerForm = `null`
	)

Creates a new PowerForm.

This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, based on the `templateId` in the request body. PowerForms that you create from a template are referred to as web PowerForms. Note: The DocuSign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a PDF PowerForm). However, PDF PowerForms are deprecated and are not supported in the API. Note: A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm initiator.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm. ### Signing modes You can use one of the following signing modes for a PowerForm: `email` This mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks Begin Signing to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document. Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code. Example: `activateonly=1` `direct` This mode does not require any verification. After a recipient enters their email address on the landing page and clicks Begin Signing, a new browser tab opens and the recipient can immediately begin the signing process. Because the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). Note: In the account settings, `enablePowerFormDirect` must be true to use `direct` as the `signingMode`. ### Redirect URLs You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see How do I specify a URL to redirect to when a PowerForm is completed?. ### More information For more information about creating PowerForms, see Create a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerForm	(optional)

Returns: Task of ApiResponse (PowerForm)

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ CreatePowerFormWithHttpInfo()

ApiResponse<PowerForm> DocuSign.eSign.Api.IPowerFormsApi.CreatePowerFormWithHttpInfo	(	string	accountId,
		PowerForm	powerForm = `null`
	)

Creates a new PowerForm.

This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, based on the `templateId` in the request body. PowerForms that you create from a template are referred to as web PowerForms. Note: The DocuSign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a PDF PowerForm). However, PDF PowerForms are deprecated and are not supported in the API. Note: A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm initiator.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm. ### Signing modes You can use one of the following signing modes for a PowerForm: `email` This mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks Begin Signing to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document. Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code. Example: `activateonly=1` `direct` This mode does not require any verification. After a recipient enters their email address on the landing page and clicks Begin Signing, a new browser tab opens and the recipient can immediately begin the signing process. Because the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). Note: In the account settings, `enablePowerFormDirect` must be true to use `direct` as the `signingMode`. ### Redirect URLs You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see How do I specify a URL to redirect to when a PowerForm is completed?. ### More information For more information about creating PowerForms, see Create a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerForm	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ DeletePowerForm()

void DocuSign.eSign.Api.IPowerFormsApi.DeletePowerForm	(	string	accountId,
		string	powerFormId
	)

Delete a PowerForm.

This method deletes a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId

Returns

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ DeletePowerFormAsync()

System.Threading.Tasks.Task DocuSign.eSign.Api.IPowerFormsApi.DeletePowerFormAsync	(	string	accountId,
		string	powerFormId
	)

Delete a PowerForm.

This method deletes a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId

Returns: Task of void

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ DeletePowerFormAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IPowerFormsApi.DeletePowerFormAsyncWithHttpInfo	(	string	accountId,
		string	powerFormId
	)

Delete a PowerForm.

This method deletes a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId

Returns: Task of ApiResponse

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ DeletePowerForms()

PowerFormsResponse DocuSign.eSign.Api.IPowerFormsApi.DeletePowerForms	(	string	accountId,
		PowerFormsRequest	powerFormsRequest = `null`
	)

Deletes one or more PowerForms

This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormsRequest	(optional)

Returns

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ DeletePowerFormsAsync()

System.Threading.Tasks.Task<PowerFormsResponse> DocuSign.eSign.Api.IPowerFormsApi.DeletePowerFormsAsync	(	string	accountId,
		PowerFormsRequest	powerFormsRequest = `null`
	)

Deletes one or more PowerForms

This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormsRequest	(optional)

Returns: Task of PowerFormsResponse

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ DeletePowerFormsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<PowerFormsResponse> > DocuSign.eSign.Api.IPowerFormsApi.DeletePowerFormsAsyncWithHttpInfo	(	string	accountId,
		PowerFormsRequest	powerFormsRequest = `null`
	)

Deletes one or more PowerForms

This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormsRequest	(optional)

Returns: Task of ApiResponse (PowerFormsResponse)

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ DeletePowerFormsWithHttpInfo()

ApiResponse<PowerFormsResponse> DocuSign.eSign.Api.IPowerFormsApi.DeletePowerFormsWithHttpInfo	(	string	accountId,
		PowerFormsRequest	powerFormsRequest = `null`
	)

Deletes one or more PowerForms

This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormsRequest	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ DeletePowerFormWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.IPowerFormsApi.DeletePowerFormWithHttpInfo	(	string	accountId,
		string	powerFormId
	)

Delete a PowerForm.

This method deletes a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId

Returns: ApiResponse of Object(void)

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ GetPowerForm()

PowerForm DocuSign.eSign.Api.IPowerFormsApi.GetPowerForm	(	string	accountId,
		string	powerFormId
	)

Returns a single PowerForm.

This method returns detailed information about a specific PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId

Returns

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ GetPowerFormAsync()

System.Threading.Tasks.Task<PowerForm> DocuSign.eSign.Api.IPowerFormsApi.GetPowerFormAsync	(	string	accountId,
		string	powerFormId
	)

Returns a single PowerForm.

This method returns detailed information about a specific PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId

Returns: Task of PowerForm

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ GetPowerFormAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<PowerForm> > DocuSign.eSign.Api.IPowerFormsApi.GetPowerFormAsyncWithHttpInfo	(	string	accountId,
		string	powerFormId
	)

Returns a single PowerForm.

This method returns detailed information about a specific PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId

Returns: Task of ApiResponse (PowerForm)

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ GetPowerFormData()

PowerFormsFormDataResponse DocuSign.eSign.Api.IPowerFormsApi.GetPowerFormData	(	string	accountId,
		string	powerFormId,
		PowerFormsApi.GetPowerFormDataOptions	options = `null`
	)

Returns the form data associated with the usage of a PowerForm.

This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm. You specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values: - `application/json`: JSON format - `application/xml`: XML format - `text/csv`: Comma-separated value (CSV) format Note: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
options	Options for modifying the behavior of the function.

Returns

◆ GetPowerFormDataAsync()

System.Threading.Tasks.Task<PowerFormsFormDataResponse> DocuSign.eSign.Api.IPowerFormsApi.GetPowerFormDataAsync	(	string	accountId,
		string	powerFormId,
		PowerFormsApi.GetPowerFormDataOptions	options = `null`
	)

Returns the form data associated with the usage of a PowerForm.

This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm. You specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values: - `application/json`: JSON format - `application/xml`: XML format - `text/csv`: Comma-separated value (CSV) format Note: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
options	Options for modifying the behavior of the function.

Returns: Task of PowerFormsFormDataResponse

◆ GetPowerFormDataAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<PowerFormsFormDataResponse> > DocuSign.eSign.Api.IPowerFormsApi.GetPowerFormDataAsyncWithHttpInfo	(	string	accountId,
		string	powerFormId,
		PowerFormsApi.GetPowerFormDataOptions	options = `null`
	)

Returns the form data associated with the usage of a PowerForm.

This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm. You specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values: - `application/json`: JSON format - `application/xml`: XML format - `text/csv`: Comma-separated value (CSV) format Note: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (PowerFormsFormDataResponse)

◆ GetPowerFormDataWithHttpInfo()

ApiResponse<PowerFormsFormDataResponse> DocuSign.eSign.Api.IPowerFormsApi.GetPowerFormDataWithHttpInfo	(	string	accountId,
		string	powerFormId,
		PowerFormsApi.GetPowerFormDataOptions	options = `null`
	)

Returns the form data associated with the usage of a PowerForm.

This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm. You specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values: - `application/json`: JSON format - `application/xml`: XML format - `text/csv`: Comma-separated value (CSV) format Note: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ GetPowerFormWithHttpInfo()

ApiResponse<PowerForm> DocuSign.eSign.Api.IPowerFormsApi.GetPowerFormWithHttpInfo	(	string	accountId,
		string	powerFormId
	)

Returns a single PowerForm.

This method returns detailed information about a specific PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ ListPowerForms()

PowerFormsResponse DocuSign.eSign.Api.IPowerFormsApi.ListPowerForms	(	string	accountId,
		PowerFormsApi.ListPowerFormsOptions	options = `null`
	)

Returns the list of PowerForms available to the user.

This method returns a list of PowerForms that are available to the user.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns

◆ ListPowerFormsAsync()

System.Threading.Tasks.Task<PowerFormsResponse> DocuSign.eSign.Api.IPowerFormsApi.ListPowerFormsAsync	(	string	accountId,
		PowerFormsApi.ListPowerFormsOptions	options = `null`
	)

Returns the list of PowerForms available to the user.

This method returns a list of PowerForms that are available to the user.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of PowerFormsResponse

◆ ListPowerFormsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<PowerFormsResponse> > DocuSign.eSign.Api.IPowerFormsApi.ListPowerFormsAsyncWithHttpInfo	(	string	accountId,
		PowerFormsApi.ListPowerFormsOptions	options = `null`
	)

Returns the list of PowerForms available to the user.

This method returns a list of PowerForms that are available to the user.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (PowerFormsResponse)

◆ ListPowerFormSenders()

PowerFormSendersResponse DocuSign.eSign.Api.IPowerFormsApi.ListPowerFormSenders	(	string	accountId,
		PowerFormsApi.ListPowerFormSendersOptions	options = `null`
	)

Returns the list of PowerForms available to the user.

This method returns a list of users who have sent PowerForms.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns

◆ ListPowerFormSendersAsync()

System.Threading.Tasks.Task<PowerFormSendersResponse> DocuSign.eSign.Api.IPowerFormsApi.ListPowerFormSendersAsync	(	string	accountId,
		PowerFormsApi.ListPowerFormSendersOptions	options = `null`
	)

Returns the list of PowerForms available to the user.

This method returns a list of users who have sent PowerForms.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of PowerFormSendersResponse

◆ ListPowerFormSendersAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<PowerFormSendersResponse> > DocuSign.eSign.Api.IPowerFormsApi.ListPowerFormSendersAsyncWithHttpInfo	(	string	accountId,
		PowerFormsApi.ListPowerFormSendersOptions	options = `null`
	)

Returns the list of PowerForms available to the user.

This method returns a list of users who have sent PowerForms.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (PowerFormSendersResponse)

◆ ListPowerFormSendersWithHttpInfo()

ApiResponse<PowerFormSendersResponse> DocuSign.eSign.Api.IPowerFormsApi.ListPowerFormSendersWithHttpInfo	(	string	accountId,
		PowerFormsApi.ListPowerFormSendersOptions	options = `null`
	)

Returns the list of PowerForms available to the user.

This method returns a list of users who have sent PowerForms.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ ListPowerFormsWithHttpInfo()

ApiResponse<PowerFormsResponse> DocuSign.eSign.Api.IPowerFormsApi.ListPowerFormsWithHttpInfo	(	string	accountId,
		PowerFormsApi.ListPowerFormsOptions	options = `null`
	)

Returns the list of PowerForms available to the user.

This method returns a list of PowerForms that are available to the user.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ UpdatePowerForm()

PowerForm DocuSign.eSign.Api.IPowerFormsApi.UpdatePowerForm	(	string	accountId,
		string	powerFormId,
		PowerForm	powerForm = `null`
	)

Creates a new PowerForm.

This method updates an existing PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
powerForm	(optional)

Returns

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ UpdatePowerFormAsync()

System.Threading.Tasks.Task<PowerForm> DocuSign.eSign.Api.IPowerFormsApi.UpdatePowerFormAsync	(	string	accountId,
		string	powerFormId,
		PowerForm	powerForm = `null`
	)

Creates a new PowerForm.

This method updates an existing PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
powerForm	(optional)

Returns: Task of PowerForm

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ UpdatePowerFormAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<PowerForm> > DocuSign.eSign.Api.IPowerFormsApi.UpdatePowerFormAsyncWithHttpInfo	(	string	accountId,
		string	powerFormId,
		PowerForm	powerForm = `null`
	)

Creates a new PowerForm.

This method updates an existing PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
powerForm	(optional)

Returns: Task of ApiResponse (PowerForm)

Implemented in DocuSign.eSign.Api.PowerFormsApi.

◆ UpdatePowerFormWithHttpInfo()

ApiResponse<PowerForm> DocuSign.eSign.Api.IPowerFormsApi.UpdatePowerFormWithHttpInfo	(	string	accountId,
		string	powerFormId,
		PowerForm	powerForm = `null`
	)

Creates a new PowerForm.

This method updates an existing PowerForm.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
powerFormId
powerForm	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.PowerFormsApi.

The documentation for this interface was generated from the following file:

sdk/src/DocuSign.eSign/Api/PowerFormsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreatePowerForm()

◆ CreatePowerFormAsync()

◆ CreatePowerFormAsyncWithHttpInfo()

◆ CreatePowerFormWithHttpInfo()

◆ DeletePowerForm()

◆ DeletePowerFormAsync()

◆ DeletePowerFormAsyncWithHttpInfo()

◆ DeletePowerForms()

◆ DeletePowerFormsAsync()

◆ DeletePowerFormsAsyncWithHttpInfo()

◆ DeletePowerFormsWithHttpInfo()

◆ DeletePowerFormWithHttpInfo()

◆ GetPowerForm()

◆ GetPowerFormAsync()

◆ GetPowerFormAsyncWithHttpInfo()

◆ GetPowerFormData()

◆ GetPowerFormDataAsync()

◆ GetPowerFormDataAsyncWithHttpInfo()

◆ GetPowerFormDataWithHttpInfo()

◆ GetPowerFormWithHttpInfo()

◆ ListPowerForms()

◆ ListPowerFormsAsync()

◆ ListPowerFormsAsyncWithHttpInfo()

◆ ListPowerFormSenders()

◆ ListPowerFormSendersAsync()

◆ ListPowerFormSendersAsyncWithHttpInfo()

◆ ListPowerFormSendersWithHttpInfo()

◆ ListPowerFormsWithHttpInfo()

◆ UpdatePowerForm()

◆ UpdatePowerFormAsync()

◆ UpdatePowerFormAsyncWithHttpInfo()

◆ UpdatePowerFormWithHttpInfo()