Versions Compared

Key

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

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
visitIdIdentifier 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

MethodDELETE

Response

Code Block
languagejs
linenumberstrue
activityStatus: "Disabled"
clinicalDiagnosis: null
clinicalStatus: null
code: null
cohort: null
comments: null
cpId: 52
cpShortTitle: "LCP"
cpTitle: "Lung Cancer Protocol"
cprId: 217
eventId: 84
eventLabel: "Initial Visit"
eventPoint: 0
extensionDetail: null
id: 328
missedBy: null
missedReason: null
name: "LP-0010-W0-PD_1449207242176"
ppid: "LP-0010"
site: "3165 Porder Drive"
sprLocked: false
sprName: null
status: "Complete"
surgicalPathologyNumber: null
visitDate: 1446791102000

 

 Error Cases :

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