Page Comparison

openspecimen/rest/ng//collection-protocol-registrations?cpId={collection-protocol-Id}

or

openspecimen/rest/ng/collection-protocol-registrations?cpId={collectionProtocolId}&registrationDate={registraitonDate}&name={paritcipantName}&query={searchString}&ppid={participantProtocolId}&uid={participantUniqueIdentifier}&participantId={masterPatientIndex}&empi={masterPatientIndex}&dob={dateOfBirth}&specimen={specimenLabel}&startAt={startAt }&max={maxResults }&includeStats={true/false}&exactMatch={true/false}

Use this resource to get participant registration details for a given protocol. This API returns all the matching participant registration details based on the searchString,  if searchString not specified then it returns all the registrations for a given collection protocol.

Use HTTP GET method to call this API by passing the below request parameters.

Below are the attributes which need to be sent in the request body:

Result:

The response of this request will contains the details of the collection protocols.

Below is the example of the get all collection protocols:

{
  "

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 | 

Error Cases :

100>
}

Parameters: