A study plan is always created in a particular application and are related to a particular course.
If you look at the tow examples below, you can see that there is a small different in the way the subjects property is formed.
This has to do with two different ways a study plan can be created in DreamApply.
a) if the subjects list has been imported into DreamApply, then the applicant can simply “tick” the subjects he/she wants to take. This is both easier for the applicant and guarantees that the data in the study plan is consistent. This also means that each subject has a proper ID, thus we can show it in the subjects dataset.
b) if the subjects list is not inserted into DreamApply, the applicant is presented with a form that he/she can fill manually, by typing the code, name, Fall/Spring and credits points manually. It is expected that the applicant has some sort of Excel/PDF for reference, but obviously there is no guarantee that the data in the study plan is correct.
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-term-type 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:
GET /api/applications/123/studyplans/1 Host: apply.example.edu Authorization: DREAM apikey="..."
Content-Type: application/json Content-Length: 1234
{
"subjects": [
{
"code": "ASTR",
"name": "Astronomy",
"academic-term-type": "/api/academic-terms/types/1",
"credits": "5"
},
{
"code": "BOT",
"name": "Botany",
"academic-term-type": "/api/academic-terms/types/1",
"credits": "2"
},
{
"code": "CAL",
"name": "Calligraphy",
"academic-term-type": "/api/academic-terms/types/1",
"credits": "3"
}
],
"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"
}
{
"subjects": {
"101": {
"code": "ASTR",
"type": "UG",
"name": "Astronomy",
"academic-term-type": "/api/academic-terms/types/1",
"credits": "5"
},
"102": {
"code": "BOT",
"type": "UG",
"name": "Botany",
"academic-term-type": "/api/academic-terms/types/1",
"credits": "2"
},
"103": {
"code": "CAL",
"type": "UG",
"name": "Calligraphy",
"academic-term-type": "/api/academic-terms/types/1",
"credits": "3"
}
},
"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"
}