Priority
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 the applicant’s preference order for a course in an application.
URI
/api/v10/applications/ID/courses/ID/priorityGET Get the course priority
Retrieve the priority level of a course in an application.
A value of 1 indicates the highest priority. Higher numerical values indicate lower priorities.
Syntax
GET /api/v10/applications/123/courses/1/priority
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/applications/123/courses/1/priority"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 1234 | The size of the response body in bytes |
| Response code | Description |
|---|---|
200 OK | The priority data was successfully returned |
404 Not Found | The application does not have this course |
Example response
Response
1PUT Set the course priority
Set the priority level for a course added to an application.
When a priority is updated, DreamApply automatically reorders existing priorities to maintain a valid sequence.
Syntax
PUT /api/v10/applications/123/courses/1/priority
Host: apply.example.edu
Authorization: DREAM apikey="..."Raw request body
The request body must contain a single integer indicating the new priority level for the course.
Request body
1Example request
Request
curl
curl \
-X PUT \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
-d '1' \
"https://apply.example.edu/api/v10/applications/123/courses/1/priority"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | text/plain | The media type of the resource |
Content-Length | 0 | The size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
204 No Content | The priority was successfully changed |
404 Not Found | The application does not have this course |
400 Bad Request | The priority value failed validation, see the error description |