txControlResponseType is a complex type. It is a sequence of three elements which occur in the order shown.
<txControlResponse xmlns="http://soapam.com/types/">
<txURL></txURL>
<txOutcome></txOutcome>
<txResult></txResult>
</txControlResponse>
A header or parameter of type txControlResponseType is included in responses from methods whose definitions include a <transactionControl> element with its clientControl attribute set to "1". An element of type txControlResponseType is also returned from the built-in TransactionControl service's BeginTransaction, CommitTransaction and AbortTransaction methods. Refer to Client Transaction Control for more information.
Elements
|
Element |
Data type |
Usage |
Default value |
Description |
|---|---|---|---|---|
|
txURL |
xsd:string |
required |
none |
A transaction URL which uniquely identifies the transaction. If the requested transaction control operation was to begin a new transaction, txURL is the new transaction identifier. Otherwise, it is the same transaction identifier specified in the request. |
|
txOutcome |
txOutcomeEnum |
required |
none |
One of: "suspended", "committed", "aborted" or "unknown" indicating the outcome of the transaction control operation. |
|
txResult |
xsd:int |
required |
none |
The result code (file system error number) of the NSK transaction control API, e.g. ENDTRANSACTION() used by SOAPam Server to execute the requested transaction control operation. If non-zero, the status of the transaction is "unknown" as indicated by txOutcome. |
Remarks
Always examine the txResult element contained in the response. If non-zero, the status of the transaction is unknown.
Example
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header>
<txControlResponse xmlns="http://soapam.com/types/">
<txURL>soapamtx://\MYSYS.0.12345678</txURL>
<txOutcome>committed</txOutcome>
<txResult>0</txResult>
</txControlResponse>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
...
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>