| Warning |
|---|
The delete participant API has been removed starting v5.0. The API was inadvertently exposed to the users. Please use Delete Registration API instead. |
openspecimen/rest/ng/participants/{participant_id}
Use this resource to delete an existing participant in the OpenSpecimen application. Use HTTP DELETE method to call this API by passing the below details:
Below are the parameters which need to be sent with the request:
Parameter | Details |
|---|---|
| participant_id | Identifier of the participant to whom you want to delete from OpenSpecimen |
| includeChildren [optional] | This is optional parameter, set the value of this variable to true, if you also want to delete all the dependents of this participant. If not set the default value is false. |
http[s]:<host>:<port>/openspecimen/rest/ng/participants/{id}
Use this URL to delete participants from OpenSpecimen application.
Result:
The response of this request will contains the identifier of the deleted participant and the success message.
Below is the example of the delete participant:
| URL | http[s]:<host>:<port>/openspecimen/rest/ng/participants/1/includeDependents=true |
| Method | DELETE |
| content-type | application/json |
Response | { "firstName" : "Jhon", "gender" : "Male Gender", "id" : "1", "lastName" : "Dep", "pmis" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "race" : [ "Asian" ], "uid" : "123-45-6789", "ethnicities" : ["Unknown"], "activityStatus" : "Active", } |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Participant deleted successfully |
| 401 | All requests | Authorization failed, User doesn’t have privileges to delete Participants |
| 500 | All requests | Internal server error, Encountered server error while performing operations |