View Source DocuSign.Api.PowerFormData (DocuSign v1.2.0)

API calls for all endpoints tagged PowerFormData.

Summary

Functions

Returns the data that users entered in 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.

Functions

Link to this function

power_forms_get_power_form_form_data(connection, account_id, power_form_id, opts \\ [])

View Source
@spec power_forms_get_power_form_form_data(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.PowerFormsFormDataResponse.t()}
  | {:error, Tesla.Env.t()}

Returns the data that users entered in 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.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • power_form_id (String.t): The ID of the PowerForm.
  • opts (keyword): Optional parameters
    • :data_layout (String.t): The layout in which to return the PowerForm data. Valid values are: - Native - Csv_Classic - Csv_One_Envelope_Per_Line - Xml_Classic
    • :from_date (String.t): The start date for a date range in UTC DateTime format. Note: If this property is null, no date filtering is applied.
    • :to_date (String.t): The end date of a date range in UTC DateTime format. The default value is UtcNow.

Returns

  • {:ok, DocuSign.Model.PowerFormsFormDataResponse.t} on success
  • {:error, Tesla.Env.t} on failure