Versions Compared

Key

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

...

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

...

visit identifier in url path


http[s]:<host>:<port>/openspecimen/rest/ng/visits?cprId=<regId>&includeStats=true/false/{visitId}

Use this URL to get visits in openSpecimen application.

...

The response of this request will contains the details of the visits with anticipated and unplanned collection statusvisit.

Below is the example of the get visits:

URLhttp://<host>:<port>/openspecimen/rest/ng/visits?cprId=539&includeStats=true/665
MethodGET
Requestapplication/json

Response

Code Block
linenumberstrue
{
cprId: 539
eventId: 84
ppid: "LP-6800"
eventLabel: "Initial Visit"
eventPoint: 0
cpId: 52
cpTitle: "Lung Cancer Protocol"
cpShortTitle: "LCP"
id: 665
name: "LP-6800-W0-PD"
clinicalDiagnosis: null
clinicalStatus: null
activityStatus: "Active"
site: "3165 Porder Drive"
status: "Complete"
comments: null
surgicalPathologyNumber: null
sprName: "stanford.txt"
missedReason: null
missedBy: null
sprLocked: false
visitDate: 144903979900012-02-2015
code: null
cohort: null
extensionDetail: null
}

...