The SetStage method allows you to set the stage of a specific instance.
int SetStage(string tokenIn, string appId, int instanceId, string instanceName, string stageId, string stageName,
bool isClosedStage, out string tokenOut)
Send Params |
Return Params |
|---|---|
•appId - This is the ID of the app we want to set the stage. •instanceId - This is the ID of the instance of the app we want to set the stage. •instanceName - When you change the stage you can re-name the instance. •isClosedStage - True if the stage is closed and no more actions are permitted. •stageId - The ID of the new stage.
•stageName - The name of the new stage. •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/SetStage"
<?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> <SetStage xmlns="http://www.PerfectApps.com/API"> <tokenIn>string</tokenIn> <appId>string</appId> <instanceId>int</instanceId> <instanceName>string</instanceName> <stageId>string</stageId> <stageName>string</stageName> <isClosedStage>boolean</isClosedStage> </SetStage> </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> <SetStageResponse xmlns="http://www.PerfectApps.com/API"> <SetStageResult>int</SetStageResult> <tokenOut>string</tokenOut> </SetStageResponse> </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> <SetStage xmlns="http://www.PerfectApps.com/API"> <tokenIn>string</tokenIn> <appId>string</appId> <instanceId>int</instanceId> <instanceName>string</instanceName> <stageId>string</stageId> <stageName>string</stageName> <isClosedStage>boolean</isClosedStage> </SetStage> </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> <SetStageResponse xmlns="http://www.PerfectApps.com/API"> <SetStageResult>int</SetStageResult> <tokenOut>string</tokenOut> </SetStageResponse> </soap12:Body> </soap12:Envelope> |
Return to: Account API Methods (SOAP), Integration
