Delete Registration

openspecimen/rest/ng/collection-protocol-registrations/{registration_id}

Use this resource to delete an existing registration from the OpenSpecimen application. Use HTTP POST method to call this API by passing the below details in JSON format.

Below are the parameters which need to be sent with the request:

Parameter	Details
registration_id	Identifier of the registration which you want to delete from OpenSpecimen

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

Use this URL to delete registration 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/collection-protocol-registrations/1
Method	DELETE
content-type	application/json
Response	{ id: 1 participant: { id: 1 firstName: "john" lastName: "cena" middleName: null activityStatus: "Disabled" registeredCps: [1] 0: "cp" - }- cpId: 1 ppid: "ASCI123er_1449205966737" activityStatus: "Disabled" registrationDate: 1398105000000 }

Error Cases :

code	Applies to	Status Message
200	All resources	Registration deleted successfully
401	All requests	Authorization failed, User doesn’t have privileges to delete Participants
404	All requests	The requested registration not found
500	All requests	Internal server error, Encountered server error while performing operations