Versions Compared

Old Version 2

changes.mady.by.user nitesh marwaha (Unlicensed)

Saved on

compared with

New Version 3

changes.mady.by.user Kaustubh Wadagavi

Saved on

Key

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

openspecimen/rest/ng/collection-protocol-registrations/{cprId}/consents

...

Parameter
Details
cprId[mandatory]Collection Protocol Registration Id
consentDocumentUrlidentifier of consent-tier to update
consentSignatureDateconsent-tier statement
consentTierResponses


parameterdetail
statementConsent tier statement defined in CP
response

Patient response. Response should be one of the below:

Yes, No, Not Specified, Withdrawn, None


witness


Domain name of the user. its mandatory if you are specifying the login name
Parameter

Details

emailAddressEmail address of the witness
loginNameLogin name of the witnessdomain

 





http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols/{cpId}/consent-tiers/1

...

Below is the example of the update consent-tier:

URLhttp[s]://<host>:<port>/openspecimen/rest/ng/collection-protocol-registrations/2/consents
MethodPOSTPUT
Requestapplication/json
json


Code Block
languagejs
themeEclipse
{
  "consentSignatureDate": "2022-04-20",
  "
consentTierResponses
witness":
[
 {
    "id": 1,
    "
statement
emailAddress:":
"Allow to use the sample for research", 
 "admin@krishagni.com"
  },
  "comments": "Consent to die",
  "responses": [
    {
      "code": "CS1",
      "response": "Yes"
    }
]
,
   
"witness
{
      "code":
{
 "CS2",
      "
emailAddress
response": "
admin@admin.com
No"
    }
  ]
}


Response


Code Block
{
    "opComments": null,
    "cprId": null,
    "cpId": null,
    "ppidcpShortTitle": null"kaustubh_cp",
    "consentDocumentUrlppid": null "PPID_KW_001",
    "consentSignatureDate": null1650412800000,
    "witness": {
        "id": 1,
        "type": "SUPER",
        "firstName": "Admin",
        "lastName": "Admin",
        "loginName": "admin@adminadmin@krishagni.com",
        "domain": "openspecimen",
        "emailAddress": "admin@adminadmin@krishagni.com",
        "instituteId": 1,
        "instituteName": "A1 - For Demo Users",
        "admin": true,
        "instituteAdmin": false,
        "phoneNumber": "",
        "manageForms": true,
        "manageWfs": true,
        "cpCount": 0,
"creationDate        "activityStatus": null"Locked"
    }
-,
    "comments": "Consent to die",
    "consentTierResponsesresponses": [
1]0:  {
"statement": "Allow to use the sample for research"
       {
         "code": "CS1",
         "response": "Yes"
       },
       {
         "code": "CS2",
         "response": "YesNo"
       }
    ],
    "consentDocumentName": null,
    "statement": null,
}
    "code": null,
    "response": null,
    "documentFile": null,
    "mergeKey": "kaustubh_cp_PPID_KW_001"
}