Consent (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 single consent configured in DreamApply. For a consent associated with a specific applicant, see Consent.
URI
/api/v10/applicants/consents/IDGET Get a consent
Retrieve information about a specific consent in DreamApply.
Syntax
GET /api/v10/applicants/consents/1
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/v10/applicants/consents/1"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 1456 | The size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The consent exists |
400 Bad Request | The consent ID was not valid |
404 Not Found | The consent was not found |
Example response
Response
{
"type": "Mandatory",
"text": "I agree to the terms and conditions of data processing",
"link": "https://apply.example.edu/terms"
}