openspecimen/rest/ng/collection-protocol-registrations/{cprId}/consents
Use this resource to save consent-tier response for participant registration in the OpenSpecimen application. Use HTTP POST 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:
Parameter | Details | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| cprId[mandatory] | Collection Protocol Registration Id | ||||||||
| consentDocumentUrl | identifier of consent-tier to update | ||||||||
| consentSignatureDate | consent-tier statement | ||||||||
| consentTierResponses |
| ||||||||
| witness |
|
http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols/{cpId}/consent-tiers/1
Use this URL to update consent-tier for Collection Protocol in the OpenSpecimen application.
Result:
The response of this request will contains the details of the updated consent-tier
Below is the example of the update consent-tier:
| URL | http://<host>:<port>/openspecimen/rest/ng/collection-protocol-registrations/2/consents |
| Method | POST |
| Request | application/json |
| json | {
"consentTierResponses":[{
"statement":"Allow to use the sample for research",
"response":"Yes"
}],
"witness":{
"emailAddress":"admin@admin.com"
}
}
|
Response | {"cprId": null"cpId": null"ppid": null"consentDocumentUrl": null"consentSignatureDate": null"witness": {"id": 1"firstName": "Admin""lastName": "Admin""loginName": "admin@admin.com""domain": "openspecimen""emailAddress": "admin@admin.com""admin": true"cpCount": 0"creationDate": null}-"consentTierResponses": [1]0: {"statement": "Allow to use the sample for research""response": "Yes"}--"consentDocumentName": null}
|