Click or drag to resize

AdministrationClientCancelTransactionBatch Method

Cancel the processing of a queued batch of Transactions, from the submitted Batch RSN. A batch cannot be cancelled after it has been processed.

This method is a step in the workflow for Transaction File Batch submission.

Remarks
Transaction File Batch submission workflow:
  • Initialise Batch - call Web Service Method: OpenTransactionBatch
  • Submit Transaction File(s) - call Web Service Method: LoadTransactionBatch
  • Monitor submitted Transaction Batch Progress - call Web Service Method: QueryTransactionBatch
  • Stop The Transaction Batch Processing - call Web Service Method: CancelTransactionBatch
  • Analyse the final results of The Transaction Batch Processing - call Web Service Method: ReportTransactionBatch
Syntax
C#
public ResultOfBatch CancelTransactionBatch(
	ManagementGroupRequestOfguid CancelBatch
)

Parameters

CancelBatch
Type: AdministrationServiceManagementGroupRequestOfguid

Return Value

Type: ResultOfBatch
Examples
C#
using (var svc = new AdministrationService.AdministrationClient())
{
  var request = new AdministrationService.ManagementGroupRequestOfguid();
  request.Token = "Token";//Required - Token returned from AccountService.ManagementGroupLogin
  request.ManagementGroup = "Management group";//Required - ManagementGroup supplied when calling AccountService.ManagementGroupLogin

  request.Value = new Guid("35798c47-7199-495a-abe3-b6e8df67a2e2");; //Required - Returned from AdministrationService.OpenTransactionBatch (ResultOfBatch.Key)

  AdministrationService.ResultOfBatch result = svc.CancelTransactionBatch(request);

  if (result.FaultCode == 0)
  {
    //Request succeeded
  }
  else
  {
    //Request failed
    throw new Exception(result.FaultDescription);
  }
}
See Also