API Reference

/rest/patients/{id}/consents/grant

put
{Protocol}://{Host}:{Port}/{Path}/rest/patients//consents/grant

Grants a single consent for a patient record identified by patient ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Internal PhenoTips identifier

Body Params
string

An internal, short identifier for the consent

string

The human readable text of the consent

boolean

Possible values: true or false. If a consent is required, then no patient data is visible unless the consent is granted.

formFields
array of strings

Optional list of patient data fields which will be hidden if this consent is not granted.

formFields
string

Possible values: yes or no. The current status of the consent for the given patient.

Responses
200

Successfully granted the patient's consent(s)

401

User not authenticated

403

User not authorized

404

Patient record or consent resource not found

Updated 3 months ago

Did this page help you?
Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 3 months ago

Did this page help you?