Consents (global)
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a list of consents configured in the system. For a list of consents associated with a specific applicant, see Consents.
URI
/api/v9/applicants/consentsGET List consents
Get a list of all the consents that are currently in the system.
Syntax
GET /api/v9/applicants/consents
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
Request
curl
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/applicants/consents"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 1456 | Size of the response body in bytes |
X-Count | 2 | Number of returned consents |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of consents was successfully returned |
Example response
Response
{
"1": {
"type": "Mandatory",
"text": "I agree to the terms and conditions of data processing",
"link": "https://apply.example.edu/terms"
},
"2": {
"type": "Voluntary",
"text": "I would like to receive newsletters",
"link": null
}
}