Page Comparison

Item Value

HTTP Method POST

URL /rest/ng/collection-protocol-registrations/list

Request Body

Code Block

language	js

{
  "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 query criteria.

Parameters:

Parameter	Details
`cpId`	Identifier of CP ID whose participants are to be 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 `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 valuevalue as a substring.
`ppid`	Matches participants by PPID. Exact or contains substring match is specified by exactMatch parameter.
`uid`	Matches participants by UID. Exact or contains match is specified by exactMatch parameterParticipants whose UID contains this parameter value as a substring.
`dob`	Matches participants by Participants whose birth date is on the date specified by this parameter value.
`specimen`	Finds participants 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 100as 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`	`startAt` and `maxResults` are useful in implementing pagination of participants list. This parameter specifies how many participant records should be included in the API response. When not specified, maxResults defaults to 100. When `startAt = n` and `maxResults = 25`, then the API response includes participants (n + 1), (n + 2), ... (n + 25) of the participants list sorted by their database generated registration IDs.
`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 sub-string match (i.e. sub-string match). Boolean true means exact match. Otherwise it is substring match.

Given below is an example of API call request body to fetch retrieve first 25 participants whose name is "John" registered to the collection protocol whose ID is 16 with ID = 16.

Code Block
POST <app-url>/rest/ng/collection-protocol-registrations { "cpId": 16, "name": "john", "startAt": 0, "maxResults": 25 }

...

Versions Compared

Old Version 7

New Version 8

Key