Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

Delete Collection Protocol Event

openspecimen/rest/ng/collection-protocol-events/{eventId}

Use this resource to delete Collection Protocol Event in the OpenSpecimen application. 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 request body :

Parameter
Details
eventIdCollection Protocol Event Id

openspecimen/rest/ng/collection-protocol-events/1

Use this URL to delete collection protocol event in the OpenSpecimen application.

Result:

The response of this request will contains the details of the deleted  collection protocol event

Below is the example of the delete collection protocol event:

URLhttp://<host>:<port>/openspecimen/rest/ng/collection-protocol-events/1
MethodDELETE

Response

{
    "id": 1,
    "activityStatus": "Active",
    "clinicalDiagnosis": "8551/3 Acinar cell cystadenocarcinoma",
    "clinicalStatus": "Operative",
    "code": null,
    "collectionProtocol": "BocaBiosciences CP",
    "defaultSite": "Bocabio Collection Site",
    "eventLabel": "Base visit",
    "eventPoint": 0
}

 Error Cases :

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

 


Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com