This method retrieves program enrolments by status only for programs that enrol contacts either through our API or through our surveys and forms tool.

🚧
Important
This method won't return results for programs that enrol contacts via program enrolment rules created in the program builder.

The select parameter requires a number between 1 and 1000 (0 is not a valid number). You may only select a maximum of 1000 results in a single request.

The skip parameter should be used in tandem with the select parameter when wanting to iterate through a whole data set. If you want to select the next 1000 records you should set the select parameter to 1000 and the skip parameter to 1000, which will return records 1001 to 2000. You should continue to do this until 0 records are returned to retrieve the whole data set.

SOAP action: http://apiconnector.com/v2/ApiService/GetEnrolmentsByStatus

📘
Input and output parameters
The input and output parameters for this method are:
Input parameters

Status - required; GUID

Select - optional; integer

Skip - optional; integer

Output parameters

GetEnrolmentsByStatusResult - array of ProgramEnrolment

ProgramEnrolment

ID - GUID

Program ID - integer

Status - string ('Processing', 'Finished')

DateCreated - dateTime

Contacts - array of integer

integer

AddressBooks - array of integer

integer

Example

using (var client = new ApiServiceClient())
{
	client.ClientCredentials.UserName.UserName = "username";
	client.ClientCredentials.UserName.Password = "password";

	var status = ApiProgramEnrolmentStatus.Processing;
	var select = 1000;
	var skip = 0;
	var enrolments = client.GetEnrolmentsByStatus(status, select, skip);
}