Click or drag to resize

AdministrationClientQueryMemberBatch Method

Returns the Batch Details metadata that enables monitoring the submitted Member Batch Progress.

This method is an optional step in the workflow for Member File Batch submission.

Remarks
Member File Batch submission workflow:
  • Initialise Batch - call Web Service Method: OpenMemberBatch
  • Submit Member File(s) - call Web Service Method: LoadMemberBatch
  • Monitor submitted Member Batch Progress - call Web Service Method: QueryMemberBatch
  • Stop The Member Batch Processing - call Web Service Method: CancelMemberBatch
  • Analyse the final results of The Member Batch Processing - call Web Service Method: ReportMemberBatch
Syntax
C#
public ResultOfBatch QueryMemberBatch(
	ManagementGroupRequestOfguid QueryBatch
)

Parameters

QueryBatch
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("31b6cce4-7770-44f8-8125-5a173075ee01");; //Required - Returned from AdministrationService.OpenMemberBatch (ResultOfBatch.Key)

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

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