Wishlist item

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

Represents a single item on the applicant’s wishlist.

URI
/api/v10/applicants/ID/wishes/ID

Get a wishlist item

Retrieve information about a specific item on the applicant’s wishlist.

A wishlist item represents a course 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/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/123/wishes/1"

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 codes

Response code	Description
`200 OK`	The item on the applicant wishlist was successfully returned
`404 Not Found`	The applicant wishlist item was not found

Example response

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

Wishlist