GetFormData

 Previous  Home topic  Next  Print this topic Send Feedback

The GetFormData method exports the form instance data in CSV/XML.

 

int GetFormData(string tokenIn, string formId, string type, out string tokenOut, out byte[] formData)

 

 

Send Params

Return Params
•formdata - The instances data in the specified format.
•formId - This is the ID of the form to retrieve.
•tokenIn - This is the security token that is obtained by the previous API call. See API Security for more details.
•type - The output type: X - XML, TS - tab separator, CS - comma separator, SS - ";" separator, HTS, HCS, HSS - same as the ones before but with headers included.

tokenOut - This is the new security token that should be used for the next Web service call after this one. See the API Security topic for more details.

 

 

Test

The test form is only available for requests from the local machine.

 

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

 

POST /api/API.asmx HTTP/1.1

Host: testing.perfectforms.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://www.PerfectForms.com/API/GetFormData"

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Body>

    <GetFormData xmlns="http://www.PerfectForms.com/API">

      <tokenIn>string</tokenIn>

      <formId>string</formId>

      <type>string</type>

    </GetFormData>

  </soap:Body>

</soap:Envelope>

 

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Body>

    <GetFormDataResponse xmlns="http://www.PerfectForms.com/API">

      <GetFormDataResult>int</GetFormDataResult>

      <tokenOut>string</tokenOut>

      <formData>base64Binary</formData>

    </GetFormDataResponse>

  </soap:Body>

</soap:Envelope>

 

 

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

 

POST /api/API.asmx HTTP/1.1

Host: testing.perfectforms.com

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

<?xml version="1.0" encoding="utf-8"?>

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>

    <GetFormData xmlns="http://www.PerfectForms.com/API">

      <tokenIn>string</tokenIn>

      <formId>string</formId>

      <type>string</type>

    </GetFormData>

  </soap12:Body>

</soap12:Envelope>

 

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

<?xml version="1.0" encoding="utf-8"?>

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>

    <GetFormDataResponse xmlns="http://www.PerfectForms.com/API">

      <GetFormDataResult>int</GetFormDataResult>

      <tokenOut>string</tokenOut>

      <formData>base64Binary</formData>

    </GetFormDataResponse>

  </soap12:Body>

</soap12:Envelope>

 

Updated: 06/12/2011  Page url: http://www.perfectforms.com/Documentation/manual/html/?fg_getformdata.htm
PerfectForms™ -- forms software, workflow software, and business process management