Show/Hide Toolbars

PerfectApps™ Help Guide

The GetListOfAppInstances method retrieves a list of an app’s instances.

 

Send Params

Return Params

firstInstanceId – This is the app’s first instance number (incrementing integer, starting at 1 for the first instance of the app).The method will return a list of instances having a higher instance number than the one specified in this parameter.

appId – This is the app id obtained from the app’s  API reference link.

Send Param formID - form ID From API Ref Link

 

tokenInThis is the security token that is obtained by the previous API call. See API Security for more details.

GetListOfAppInstancesResult – This is the integer result indicating success ( = 0 ) or an error (<> 0).

instancesList – This is the list of app 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.

 

 

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: app.perfectforms.com

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

Content-Length: length

SOAPAction: "http://www.PerfectApps.com/API/GetListOfAppInstances"

 

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

    <GetListOfAppInstances xmlns="http://www.PerfectApps.com/API">

      <tokenIn>string</tokenIn>

      <appId>string</appId>

      <firstInstanceId>int</firstInstanceId>

    </GetListOfAppInstances>

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

    <GetListOfAppInstancesResponse xmlns="http://www.PerfectApps.com/API">

      <GetListOfAppInstancesResult>int</GetListOfAppInstancesResult>

      <tokenOut>string</tokenOut>

      <instancesList>string</instancesList>

    </GetListOfAppInstancesResponse>

  </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: app.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>

    <GetListOfAppInstances xmlns="http://www.PerfectApps.com/API">

      <tokenIn>string</tokenIn>

      <appId>string</appId>

      <firstInstanceId>int</firstInstanceId>

    </GetListOfAppInstances>

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

    <GetListOfAppInstancesResponse xmlns="http://www.PerfectApps.com/API">

      <GetListOfAppInstancesResult>int</GetListOfAppInstancesResult>

      <tokenOut>string</tokenOut>

      <instancesList>string</instancesList>

    </GetListOfAppInstancesResponse>

  </soap12:Body>

</soap12:Envelope>

 

 

Return to: Account API Methods (SOAP), Integration