Page Comparison

openspecimen/rest/ng/collection-prorocols/{id}

or

openspecimen/rest/ng/collection-prorocols/title={title}

or

openspecimen/rest/ng/collection-prorocols/shortTitle={shortTitle}

cpId}

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

...

Parameter	Details
cpId	Id of the collection protocol to be deleted
title	Title of the collection protocol to be deleted
shortTitle	Short title of the collection protocol to be deleted

http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols/{id}or

http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols/title={title}

or

http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols/shortTitle={shortTitle}

Use this URL to delete Collection Protocol in openSpecimen application.

...

URL	`http://<host>:<port>/`openspecimen/rest/ng/collection-protocols/1 or `http://<host>:<port>/`openspecimen/rest/ng/collection-protocols/title=MyCP or `http://<host>:<port>/`openspecimen/rest/ng/collection-protocols/shortTitle=cps
Method	DELETE
Request	application /json
Response	"success"Method	DELETE
Response	{ "id": 1, "shortTitle": "A Planned Clinical Study FD", "title": "Planned Clinical Study", "code": null, "principalInvestigator": { "id": 1, "firstName": "Admin", "lastName": "Admin", "loginName": "admin@admin.com", "domain": "openspecimen", "emailAddress": "openspecimendemo@gmail.com", "admin": true, "cpCount": 0, "creationDate": null }, "startDate": 1427653800000, "endDate": 1454178600000, "participantCount": null, "specimenCount": null, "ppidFmt": "DWP%05d", "manualPpidEnabled": false, "coordinators": [ ], "cpSites": [ { "id": 2, "siteName": "Arkansas Repository", "code": "CS_123" }, { "id": 25, "siteName": "Arkansas Hospital", "code": "CS_34" } ], "consentsWaived": false, "irbId": "65465", "anticipatedParticipantsCount": null, "descriptionUrl": null, "specimenLabelFmt": "%PPI%.%SP_TYPE%.%SYS_UID%", "derivativeLabelFmt": "%PPI%.%SP_TYPE%.%SYS_UID%", "aliquotLabelFmt": "%PSPEC_LABEL%.%PSPEC_UID%", "visitNameFmt": null, "manualVisitNameEnabled": false, "manualSpecLabelEnabled": true, "aliquotsInSameContainer": null, "activityStatus": "Active", "consents": null, "events": 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