This is an old revision of the document!


/api/applications/ID/studyplans

HEAD, GET

Get a list of study plans that have been attached to this application. 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 more study plans, but only a subset of them may be attached to this particular application. Use the /api/applicants/ID/studyplans call to see all of the study plans that have been created by an applicant regardless of application.

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

A study plan is always created in a particular application and are related to a particular course (you can see the identifiers in the example data below).

The statuses can currently be:

  • Blank
  • Prepare
  • Completed
  • Accepted
  • Closed

Syntax

GET /api/applications/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/applicant/123",
      "status": "Prepare"
  }
}