| Item | Value |
|---|---|
| HTTP Method | POST |
| URL | /rest/ng/collection-protocol-registrations/list |
| Request Body | {
"cpId": <collection protocol ID>,
"registrationDate": <registration date>,
"ppid": <ppid>
"name": <participant first name or last name>
"dob": <birth date>,
"uid": <SSN or any national ID>,
"specimen" <specimen label or barcode>,
"includeStats": <true|false>,
"startAt": <startAt | 0>,
"maxResults": <maxResults | 100>
}
|
| Response Body | List of registered participants that match the requested criteria. |
Parameters:
Parameter | Details |
|---|---|
| cpId | Identifier of CP whose participants are queried. Mandatory parameter. |
| searchStr | Query string. Finds participants whose first name or last name or UID contains query string. |
| registraitonDate | Participant registration date |
| name | Finds participants whose first name or last name contains this parameter value. |
| ppid | Matches participants by PPID. Exact or contains match is specified by exactMatch parameter. |
| uid | Matches participants by UID. Exact or contains match is specified by exactMatch parameter. |
| dob | Matches participants by birth date |
| specimen | Finds participants whose specimen labels or barcodes contains this parameter value |
| startAt | Specifies the starting participant to include in the response. |
| maxResults | Maximum number of records to fetch. By default it will be 100 |
| includeStats | Boolean specifying whether participant statistics like visits, specimens count should be included in the response |
| exactMatch | Specifies whether the PPID or UID match should be exact match or contains match (i.e. sub-string match). |
Given below is an example of API call request body to fetch first 25 participants whose name is "John" registered to collection protocol whose ID is 16
POST <app-url>/rest/ng/collection-protocol-registrations
{
"cpId": 16,
"name": "john",
"startAt": 0,
"maxResults": 25
}