GetEnrolmentById

Gets a program enrolment by ID

This method retrieves a program enrolment and its status by its ID (GUID).

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

πŸ“˜

Input and output parameters

The input and output parameters for this method are:

Input parameters

  • Enrolment ID - required; GUID

Output parameters

  • GetEnrolmentByIdResult
    • EnrolmentID - 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 enrolmentId = new Guid("00000000-0000-0000-0000-000000000000");
	var enrolment = client.GetEnrolmentById(enrolmentId);
}