Priority

Represents the applicant’s preference order for a course in an application.

/api/v9/applications/ID/courses/ID/priority

GET Get the course priority

Get the priority level of a specific course in an application.

A value of 1 indicates the highest priority. Higher numerical values indicate lower priorities.

GET /api/v9/applications/123/courses/1/priority
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/applications/123/courses/1/priority"

Response headers

Example response

1

PUT Set the course priority

Sets the priority level for a course added to the application.

When a priority is updated, the API automatically reorders existing priorities to maintain a valid sequence.

PUT /api/v9/applications/123/courses/1/priority
Host: apply.example.edu
Authorization: DREAM apikey="..."

Raw request body

Provide the new priority value as a single integer in the request body.

1

Example request

curl \
  -X PUT \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  -d '1' \
  "https://apply.example.edu/api/v9/applications/123/courses/1/priority"

Response headers

Response codes