Click or drag to resize

AdministrationClientOpenMemberBatch Method

Initialise the Batch for submitting file(s) containing Members. The service returns the Batch Details, containing a key for calling the subsequent workflow Member Batch methods.

This method is a 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 OpenMemberBatch(
	ManagementGroupRequestOfOpenBatch OpenMemberBatch1
)

Parameters

OpenMemberBatch1
Type: AdministrationServiceManagementGroupRequestOfOpenBatch

Return Value

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

  var openBatch = new AdministrationService.OpenBatch();
  openBatch.BatchOwnerRSN = new Guid("bfb5da5e-70ca-40e5-b905-0d120479d643");; //Required - usually AccountOwnerRSN of the logged in admin
  openBatch.FileName = "NewMembers.csv"; //Required - uploaded file name
  openBatch.Merge = true; //Required - Merge to existing members based on matching rules

  request.Value = openBatch;//Required 

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

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