Page Comparison

openspecimen/rest/ng/visits/{visitId}

Use this resource to get visits. This API returns all visit.

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
cprId	Identifier 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=<regId>&includeStats=true/false

Use this URL to get visits in openSpecimen application.

Result:

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

Below is the example of the get visits:

URL http://<host>:<port>/openspecimen/rest/ng/visits?cprId=539&includeStats=true

Method GET

Request application/json

Response

Code Block

linenumbers	true

{
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: 1449039799000
code: null
cohort: null
extensionDetail: null
}

Error Cases :

code	Applies to	Status Message
200	All resources	Specimen collection groups got successfully
401	All requests	Authorization failed, user doesn’t have authority
500	All requests	Internal server error, encountered server error while performing operations

Versions Compared

Old Version 1

New Version 2

Key