Versions Compared

Key

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

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

or

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

or

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


Use this resource to delete the Collection Protocol. 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 URL :

Parameter
Details
cpIdCP id Id of the collection protocol to be deleted
titleTitle of the collection protocol to be deleted
shortTitleShort 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/{cpIdtitle={title}

or

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


Use this URL to delete Collection Protocol in openSpecimen application.

...

Below is the example of the delete Collection Protocol:

URL

http://<host>:<port>/openspecimen/rest/ng/collection-protocols/1

or

http://<host>:<port>/openspecimen/rest/ng/collection-protocols/

{cpId}

title=MyCP

or

http://<host>:<port>/openspecimen/rest/ng/collection-protocols/shortTitle=cps

MethodDELETE
Requestapplication /json

Response

"success"

...