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/v9/applicants/ID/wishes

List wishes

Get a list of courses that the applicant in question has shown interest for. In more formal terms, this is the applicant’s wishlist. An applicant may collect interesting courses to his wishlist for later application or further evaluation.

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

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`X-Count`	`2`	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/v9/applicants/60",
    "course": "/api/v9/course/1",
    "intake": null,
    "notes": null
  }
}

Invoices

Wishlist item