The GetAppInstanceData method returns an app instance’s content in XML format.
Send Params |
Return Params |
|---|---|
•appId – This is the app id obtained from the app’s API reference link 
•instanceid – This is the app’s instance number (incrementing integer, starting at 1 for the first instance of the app) •tokenIn – This is the security token that is obtained by the previous API call. See API Security for more details. |
•data – This is the app instance’s content in XML format. •GetAppInstanceDataResult – This is the integer result indicating success ( = 0 ) or an error (<> 0). •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. |
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/GetAppInstanceData"
<?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> <GetAppInstanceData xmlns="http://www.PerfectApps.com/API"> <tokenIn>string</tokenIn> <appId>string</appId> <instanceId>int</instanceId> </GetAppInstanceData> </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> <GetAppInstanceDataResponse xmlns="http://www.PerfectApps.com/API"> <GetAppInstanceDataResult>int</GetAppInstanceDataResult> <tokenOut>string</tokenOut> <data>string</data> </GetAppInstanceDataResponse> </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> <GetAppInstanceData xmlns="http://www.PerfectApps.com/API"> <tokenIn>string</tokenIn> <appId>string</appId> <instanceId>int</instanceId> </GetAppInstanceData> </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> <GetAppInstanceDataResponse xmlns="http://www.PerfectApps.com/API"> <GetAppInstanceDataResult>int</GetAppInstanceDataResult> <tokenOut>string</tokenOut> <data>string</data> </GetAppInstanceDataResponse> </soap12:Body> </soap12:Envelope> |
Return to: Account API Methods (SOAP), Integration
