Wishlist

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Represents the applicant’s wishlist.

URI
/api/v10/applicants/ID/wishes

List wishes

Retrieve the applicant’s wishlist — a list of courses that the applicant has shown interest to, but has not yet added to any application. An applicant may save interesting courses to their wishlist for further evaluation or future applications.

Syntax
GET /api/v10/applicants/123/wishes
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/123/wishes"

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
`X-Count`	`2`	The number of returned wishlist items

Response codes

Response code	Description
`200 OK`	The list of items on the wishlist was successfully returned

Example response

Response
{
  "1": {
    "wished": "1970-01-01T00:00:01+00:00",
    "applicant": "/api/v10/applicants/60",
    "course": "/api/v10/course/1",
    "intake": null,
    "notes": null
  }
}

Emails

Wishlist item