Versions Compared

Version Old Version 1 New Version Current
Changes made by

nitesh marwaha (Unlicensed)

Vinod Gaikwad (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

openspecimen/rest/ng/specimen-collection-groups

or

openspecimen/rest/ng/specimen-collection-groups?start={start}&max={maxResults}&searchString={searchString}&countReq={visits?cprId=<regId>&includeStats=true/false}

Use this resource to get specimen collection groupsvisits. This API returns all the matching specimen collection groups based on the searchString,  if searchString not specified then it returns all the specimen collection groups present in the openSpecimen applicationvisits for the given registration id.

Use HTTP GET method to call this API by passing the below details in JSON format. 

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

Parameter
Details
searchString [optional]The value with which you want to search the specimen collection groups. The given value will be matched with Name and Barcode.
start [optional]start index of the results
maxResults [optional]Maximum number of records to fetch. By default it will be 100
countReq [optional]Set this parameter to true, if want to get the total count of matching resultscprIdIdentifier of the collection protocol registration.
includeStats [optional]For true value, API will return collection status of visits which include planned and unplanned collection. By default false value is set.


http[s]:<host>:<port>/openspecimen/rest/ng/specimen-collection-groups

 

/visits?cprId=<regId>&includeStats=true/false

Use this URL to get specimen collection groups get visits in openSpecimen application.

...

The response of this request will contains the details of the specimen collection groupsvisits with anticipated and unplanned collection status.

Below is the example of the get specimen collection groupsvisits:

URLhttp://<host>:<port>/openspecimen/rest/ng/specimen-collection-groups?searchString=Breast Cancer CP_61_154visits?cprId=539&includeStats=true
MethodGET
Requestapplication/json

Response

Code Block
linenumberstrue
[
{
   "id":1,
   "cprId":5,
   "cpeId":2,
   "name":"Breast Cancer CP_61_154",
   "clinicalDiagnosis":"Not Specified",
   "clinicalStatus":"Not Specified",
   "activityStatus":"Active",
   "collectionSiteName":"ATCC",
   "collectionStatus":"Complete",
   "barcode":"barcode1",
   "surgicalPathologyNumber":"path123",
   "collectorName":"tester@site.com",
   "collectionTimestamp":"2014-04-21",
   "collectionComments":"comments",
   "collectionProcedure":"Lavage",
   "collectionContainer":"CPT",
   "receiverName":"tester@site.com",
   "receivedTimestamp":"2014-04-21",
   "receivedQuality":"Clotted"
}]

 

...


0:  {
id: 665
eventId: 84
name: "LP-6800-W0-PD"
eventLabel: "Initial Visit"
eventPoint: 0
status: "Complete"
visitDate: 1449039799000
anticipatedVisitDate: 1448994600000
anticipatedSpecimens: 12
collectedSpecimens: 9
uncollectedSpecimens: 0
unplannedSpecimens: 0
missedReason: null
missedBy: null
}
-

1:  {
id: null
eventId: 85
name: null
eventLabel: "Week Two"
eventPoint: 7
status: null
visitDate: null
anticipatedVisitDate: 1449599400000
anticipatedSpecimens: 3
collectedSpecimens: 0
uncollectedSpecimens: 0
unplannedSpecimens: 0
missedReason: null
missedBy: null
}
]

Error Cases :

code
Applies to
Status Message
200All resourcesSpecimen collection groups got successfully
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations