catissuecoreopenspecimen/rest/ng/participants/{participant_id}
Use this resource to delete an existing participant in the caTissue OpenSpecimen application. Use HTTP DELETE method to call this API by passing the below details:
...
Parameter | Details |
|---|---|
| participant_id | Identifier of the participant to whom you want to delete from caTissuePlusOpenSpecimen |
| includeDependents 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>/catissuecoreopenspecimen/rest/ng/participants/{id}
Use this URL to delete participants from caTissuePlus OpenSpecimen application.
Result:
The response of this request will contains the identifier of the deleted participant and the success message.
...
| URL | http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/participants/1/includeDependents=true |
| Method | DELETE |
| content-type | application/json |
Response | { "activityStatus" : "Active", "ethnicity" : "Unknown", "firstName" : "Jhon", "gender" : "Male Gender", "id" : "1", "lastName" : "Dep", "pmis" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "race" : [ "Asian" ], "uid" : "123-45-6789" } |
Error Cases :
code | Applies to | Status Message | |||
|---|---|---|---|---|---|
| 200 | All resources | Participant deleted successfully | 400 | All requests | |
| 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 |
...