Versions Compared

Version Old Version 2 New Version 3
Changes made by

nitesh marwaha

Vinod Gaikwad

Saved on

Key

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

openspecimen/rest/ng/visits?cprId=3<regId>&includeStats=true/false

Use this resource to get specimen collection groupsvisits. This API returns all visits for the given registration id.

...

Parameter
Details
cprIdIdentifier 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/visits?cprId=2 =<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/visits?cprId=539&includeStats=3true
MethodGET
Requestapplication/json

Response

Code Block
linenumberstrue
[
{

"id":1,

"eventId":7,

"name":"Test1234_Initial Visit_1",

"eventLabel":"Initial Visit",

"eventPoint":0,

"status":"Complete",

"visitDate":1432013976000,

"anticipatedVisitDate":1431921600000,

"anticipatedSpecimens":1,

"collectedSpecimens":2,

"uncollectedSpecimens":1,

"unplannedSpecimens":1,

}]

...


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