The GetAppInstanceMetaData method returns a variety of detailed information about an instance.
int GetAppInstanceMetaData(string tokenIn, string appId, int instanceId, out string tokenOut, out string
appInstanceName, out int appInstanceNumber, out string link, out string stageId, out string stageName,
out short majorVersion, out short minorVersion)
Send Params |
Return Params |
|---|---|
•appId •appInstanceName •appInstanceNumber •instanceId •link •majorVersion •minorVersion •stageId •stageName •tokenIn - This is the security token that is obtained by the previous API call. See the API Security topic for more details. |
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/GetAppInstanceMetaData"
<?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> <GetAppInstanceMetaData xmlns="http://www.PerfectApps.com/API"> <tokenIn>string</tokenIn> <appId>string</appId> <instanceId>int</instanceId> </GetAppInstanceMetaData> </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> <GetAppInstanceMetaDataResponse xmlns="http://www.PerfectApps.com/API"> <GetAppInstanceMetaDataResult>int</GetAppInstanceMetaDataResult> <tokenOut>string</tokenOut> <appInstanceName>string</appInstanceName> <appInstanceNumber>int</appInstanceNumber> <link>string</link> <stageId>string</stageId> <stageName>string</stageName> <majorVersion>short</majorVersion> <minorVersion>short</minorVersion> </GetAppInstanceMetaDataResponse> </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> <GetAppInstanceMetaData xmlns="http://www.PerfectApps.com/API"> <tokenIn>string</tokenIn> <appId>string</appId> <instanceId>int</instanceId> </GetAppInstanceMetaData> </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> <GetAppInstanceMetaDataResponse xmlns="http://www.PerfectApps.com/API"> <GetAppInstanceMetaDataResult>int</GetAppInstanceMetaDataResult> <tokenOut>string</tokenOut> <appInstanceName>string</appInstanceName> <appInstanceNumber>int</appInstanceNumber> <link>string</link> <stageId>string</stageId> <stageName>string</stageName> <majorVersion>short</majorVersion> <minorVersion>short</minorVersion> </GetAppInstanceMetaDataResponse> </soap12:Body> </soap12:Envelope> |
Return to: Account API Methods (SOAP), Integration
