|
GetFormInstanceMetaData |
|
|
|
GetFormInstanceMetaData |
|
|
The GetFormInstanceMetaData method returns a variety of detailed information about an instance.
int GetFormInstanceMetaData(string tokenIn, string formId, int instanceId, out string tokenOut, out string
formInstanceName, out int formInstanceNumber, out string link, out string stageId, out string stageName,
out short majorVersion, out short minorVersion)
Send Params |
Return Params |
||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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/GetFormInstanceMetaData"
<?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> <GetFormInstanceMetaData xmlns="http://www.PerfectForms.com/API"> <tokenIn>string</tokenIn> <formId>string</formId> <instanceId>int</instanceId> </GetFormInstanceMetaData> </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> <GetFormInstanceMetaDataResponse xmlns="http://www.PerfectForms.com/API"> <GetFormInstanceMetaDataResult>int</GetFormInstanceMetaDataResult> <tokenOut>string</tokenOut> <formInstanceName>string</formInstanceName> <formInstanceNumber>int</formInstanceNumber> <link>string</link> <stageId>string</stageId> <stageName>string</stageName> <majorVersion>short</majorVersion> <minorVersion>short</minorVersion> </GetFormInstanceMetaDataResponse> </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> <GetFormInstanceMetaData xmlns="http://www.PerfectForms.com/API"> <tokenIn>string</tokenIn> <formId>string</formId> <instanceId>int</instanceId> </GetFormInstanceMetaData> </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> <GetFormInstanceMetaDataResponse xmlns="http://www.PerfectForms.com/API"> <GetFormInstanceMetaDataResult>int</GetFormInstanceMetaDataResult> <tokenOut>string</tokenOut> <formInstanceName>string</formInstanceName> <formInstanceNumber>int</formInstanceNumber> <link>string</link> <stageId>string</stageId> <stageName>string</stageName> <majorVersion>short</majorVersion> <minorVersion>short</minorVersion> </GetFormInstanceMetaDataResponse> </soap12:Body> </soap12:Envelope> |
Updated: 06/12/2011
Page url:
http://www.perfectforms.com/Documentation/manual/html/?fg_getforminstancemetadata.htm
PerfectForms™ -- forms software, workflow software, and business process management