GetListOfFormInstances

 Previous  Home topic  Next  Print this topic Send Feedback

The GetListOfFormInstances method retrieves a list of a form’s instances.

 

Send Params

Return Params
•firstInstanceId – This is the form’s first instance number (incrementing integer, starting at 1 for the first instance of the form).The method will return a list of instances having a higher instance number than the one specified in this parameter.
•formId – This is the form id obtained from the form’s  API reference link.

Send Param formID - form ID From API Ref Link

•tokenIn – This is the security token that is obtained by the previous API call. See API Security for more details.
•GetListOfFormInstancesResult – This is the integer result indicating success ( = 0 ) or an error (<> 0).
•instancesList – This is the list of form instances in XML format.
•tokenOut – This is the new security token that should be used for the next Web service call after this one. See the API Security 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/GetListOfFormInstances"

 

<?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>

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

      <tokenIn>string</tokenIn>

      <formId>string</formId>

      <firstInstanceId>int</firstInstanceId>

    </GetListOfFormInstances>

  </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>

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

      <GetListOfFormInstancesResult>int</GetListOfFormInstancesResult>

      <tokenOut>string</tokenOut>

      <instancesList>string</instancesList>

    </GetListOfFormInstancesResponse>

  </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>

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

      <tokenIn>string</tokenIn>

      <formId>string</formId>

      <firstInstanceId>int</firstInstanceId>

    </GetListOfFormInstances>

  </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>

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

      <GetListOfFormInstancesResult>int</GetListOfFormInstancesResult>

      <tokenOut>string</tokenOut>

      <instancesList>string</instancesList>

    </GetListOfFormInstancesResponse>

  </soap12:Body>

</soap12:Envelope>

 

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