Implementation
This action performs a search for Participants with a set enrollment period.
Response Class (Status 201)
"Successfully completed Participant Search based on enrollment period"
Parameters
Parameter | Description | Data Type |
EnterpriseGuid | Enterprise ID represents which Enterprise you are accessing. | string |
SecurityToken | Security Token is retrieved through login process. | string |
programid | Program specific ID. | string |
startdate | Begin Date parameter | string |
enddate | End Date parameter | string |
flag | Active = 1 Enrolled = 2 Dismissed = 3 | integer |
If using this search using a flag of 1, you will be querying the database for Participants active within your start and end date.
Active Participants are Participants who were active for at least one day in the date range defined.
Enrolled Participants are Participants with a program start date in the given date range.
Dismissed Participants have a Program end date in the date range.