Click or drag to resize

AdministrationClientSelectProgramList Method

Return a collection of Programs, filtered from the submitted values.

Pagination parameters are available to format the response.

Syntax
C#
public ResultOfPagedCollectionOfProgramStub SelectProgramList(
	ManagementGroupRequestOfProgramSearchFilter request
)

Parameters

request
Type: AdministrationServiceManagementGroupRequestOfProgramSearchFilter

Return Value

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

  var programSearchFilter = new AdministrationService.ProgramSearchFilter(); //Required
  programSearchFilter.ParentProgram_RSN = Guid.Empty; //Optional
  programSearchFilter.PageNumber = 1; //Optional - Defaults to 1
  programSearchFilter.PageSize = 100; //Optional - Defaults to 100

  request.Value = programSearchFilter;

  AdministrationService.ResultOfPagedCollectionOfProgramStub result = svc.SelectProgramList(request);

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