Table of Contents

/api/applicants/ID/studyplans

HEAD, GET

Get a list of study plans that have been created by this applicant. The HEAD verb is useful if you only want to test if this application has any study plans attached at all (and how many). Use the GET verb to get the listing of study plans.

Note that an applicant may have several study plans, but only a subset of them may be attached to a particular application. Use the /api/applications/ID/studyplans call to see all of the study plans that have been created in a particular application.

To see the complete data for a study plan, including the subjects selected, query the study plan by it's ID using /api/applicants/ID/studyplans/ID.

A study plan is always created in a particular application and are related to a particular course.

The statuses can currently be:

Syntax

GET /api/applicants/123/studyplans
Host: apply.example.edu
Authorization: DREAM apikey="..."

Response headers

Content-Type: application/json
Content-Length: 1234
X-Count: 15

Response example

{
  "1": {
      "created": "2015-02-13T15:55:46+00:00",
      "revised": "2015-02-13T15:56:10+00:00",
      "course": "/api/courses/321",
      "applicant": "/api/applicants/123",
      "application": "/api/applications/123",
      "status": "Prepare"
  }
}