Page Comparison

openspecimen/rest/ng/visits/{visitId}

This resource is used to delete visit. User can delete visit only if he has access on delete visit.

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

Below are the attributes which need to be sent in the URL :

Parameter	Details
visitId	Identifier of the visit to be deleted

http[s]:<host>:<port>/openspecimen/rest/ng/visits/{id}

Use this URL to delete visit in openSpecimen application.

Result:

The response of this request will contains the details of the deleted visit.

Below is the example of the delete Collection Protocol:

URL

http://<host>:<port>/openspecimen/rest/ng/visits/1

Method DELETE

Response

Code Block

language	js
linenumbers	true

{
cprId: 217
eventId: 84
ppid: "LP-0010"
eventLabel: "Initial Visit"
eventPoint: 0
cpId: 52
cpTitle: "Lung Cancer Protocol"
cpShortTitle: "LCP"
id: 689
name: "LP-0010-W0-PD_1449207545946"
clinicalDiagnosis: "Not Specified"
clinicalStatus: "Not Specified"
activityStatus: "Disabled"
site: "3165 Porder Drive"
status: "Complete"
comments: null
surgicalPathologyNumber: null
sprName: null
missedReason: null
missedBy: null
sprLocked: false
visitDate: 1446748200000
code: null
cohort: null
extensionDetail: null
}

Error Cases :

code	Applies to	Status Message
200	All resources	Collection Protocol has been deleted successfully
401	All requests	Authorization failed, user doesn’t have authority
404	All requests	Collection Protocol not found, collection Protocol with given details not present in the system
500	All requests	Internal server error, encountered server error while performing operations

Versions Compared

Old Version 1

New Version Current

Key