This is an old revision of the document!

/api/applications/ID/studyplans/ID

HEAD, GET

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).

Explanation of data

The subjects element can contain objects with the following properties:

code This is the subject code, normally what is used by the university internally. You may use this code to match the study plan entries to your SIS.
name name of the subject.
academic-year holds an identifier to a resource describing the academic year (Fall,Spring etc.).
credits is the number of ECTS credits for this subject.
type refers to the classificator Subject type. This is only available if the applicant selects the subjects (as opposed to inserting manually).

The statuses can currently be:

Blank
Prepare
Completed
Accepted
Closed

Syntax

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

Response headers

Content-Type: application/json
Content-Length: 1234

Response example (applicant inserts subjects)

{
  "subjects": [
      {
          "code": "ASTR",
          "name": "Astronomy",
          "academic-term": "/api/academic-terms/1",
          "credits": "5"
      },
      {
          "code": "BOT",
          "name": "Botany",
          "academic-term": "/api/academic-terms/1",
          "credits": "2"
      },
      {
          "code": "CAL",
          "name": "Calligraphy",
          "academic-term": "/api/academic-terms/1",
          "credits": "3"
      }
  ],
  "created": "2015-02-13T15:55:46+00:00",
  "revised": "2015-02-13T15:56:10+00:00",
  "course": "/api/courses/321",
  "application": "/api/applications/123",
  "status": "Prepare"
}

Response example (applicant chooses subjects)

{
  "subjects": {
      "101": {
          "code": "ASTR",
          "type": "UG",
          "name": "Astronomy",
          "academic-term": "/api/academic-terms/1",
          "credits": "5"
      },
      "102": {
          "code": "BOT",
          "type": "UG",
          "name": "Botany",
          "academic-term": "/api/academic-terms/1",
          "credits": "2"
      },
      "103": {
          "code": "CAL",
          "type": "UG",
          "name": "Calligraphy",
          "academic-term": "/api/academic-terms/1",
          "credits": "3"
      }
  },
  "created": "2015-02-13T15:55:46+00:00",
  "revised": "2015-02-13T15:56:10+00:00",
  "course": "/api/courses/321",
  "application": "/api/applications/123",
  "status": "Prepare"
}