DocuSign.Api.PowerFormData (DocuSign v3.1.1)
View SourceAPI 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 You can further specify the type of CSV format in the data_layout query parameter. Note: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.
Functions
@spec power_forms_get_power_form_form_data( DocuSign.Connection.t(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.PowerFormsFormDataResponse.t()} | {:error, Req.Response.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 You can further specify the type of CSV format in the data_layout query parameter. Note: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.
Parameters
connection(DocuSign.Connection): Connection to serveraccount_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. For each of the following layouts, set theAcceptheader to the corresponding value. Valid values are: -Native(SetAcceptheader toapplication/json) -Csv_Classic(SetAcceptheader toapplication/csv) -Csv_One_Envelope_Per_Line(SetAcceptheader totext/csv) -Xml_Classic(SetAcceptheader toapplication/xml):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 isUtcNow.
Returns
{:ok, DocuSign.Model.PowerFormsFormDataResponse.t}on success{:error, Req.Response.t}on failure