| Item | Value |
|---|---|
| HTTP Method | POST |
| URL | /rest/ng/collection-protocol-registrations/list |
| Request Body | {
"cpId": <collection protocol ID>,
"registrationDate": <registration date>,
"ppid": <ppid>,
"externalSubjectIds":[ <External Subject Identifier> ],
"name": <participant first name or last name>
"dob": <birth date>,
"participantId": <MRN or eMPI orSSN 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 query criteria. |
Parameters:
Parameter | Details |
|---|---|
cpId | ID of the collection protocol whose participants are to be returned. |
registrationDate | List of participants registered to the CP on date specified by this parameter value. |
name | Participants whose first name or last name contains this parameter value as a substring. |
ppid | Matches participants by PPID. Exact or substring match is specified by exactMatch parameter. |
| externalSubjectIds | Matches participants by external subject ID. Need to specify an array of external subject IDs. e.g. "externalSubjectIds":["KW001"] |
participantId | Participants whose UID / eMPI / MRN contains this parameter value as a substring. |
dob | Participants whose birth date is on the date specified by this parameter value. |
specimen | Participants whose specimen labels or barcodes contains this parameter value as a substring. |
startAt | startAt and maxResults are useful in implementing pagination of participants list. When not specified, startAt defaults to 0. When startAt = n, the first element of the response is (n + 1)th participant satisfying the query criteria. |
maxResults |
When |
includeStats | Boolean specifying whether participant statistics like visits, specimens count should be included in the response |
exactMatch | Specifies whether the PPID should be exact match or sub-string match. Boolean true means exact match. Otherwise it is substring match. |
Given below is an example of API call request body to retrieve first 25 participants whose name is "John" registered to the collection protocol with ID = 16.
POST <app-url>/rest/ng/collection-protocol-registrations/list
{
"cpId": 16,
"name": "john",
"startAt": 0,
"maxResults": 25
}