| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| api:api_applications_id_studyplans_id [2015/02/13 16:24] – Lauri | api:api_applications_id_studyplans_id [2024/07/30 11:50] (current) – external edit 127.0.0.1 |
|---|
| ===== HEAD, GET ===== | ===== 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). | A study plan is always created in a particular application and are related to a particular course. |
| |
| ==== Insert //vs// Select ==== | ==== Insert subjects vs Select subjects ==== |
| |
| 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. | 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. | 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. | 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. | 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. |
| |
| |
| * ''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. | * ''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. | * ''name'' name of the subject. |
| * ''academic-year'' holds an identifier to a resource describing the academic year (Fall,Spring etc.). | * ''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. | * ''credits'' is the number of ECTS credits for this subject. |
| * ''type'' refers to the [[api:api_classificators|classificator]] ''Subject type''. This is only available if the applicant selects the subjects (as opposed to inserting manually). | * ''type'' refers to the [[api:api_classificators|classificator]] ''Subject type''. This is only available if the applicant selects the subjects (as opposed to inserting manually). |
| "code": "ASTR", | "code": "ASTR", |
| "name": "Astronomy", | "name": "Astronomy", |
| "academic-term": "/api/academic-terms/1", | "academic-term-type": "/api/academic-terms/types/1", |
| "credits": "5" | "credits": "5" |
| }, | }, |
| "code": "BOT", | "code": "BOT", |
| "name": "Botany", | "name": "Botany", |
| "academic-term": "/api/academic-terms/1", | "academic-term-type": "/api/academic-terms/types/1", |
| "credits": "2" | "credits": "2" |
| }, | }, |
| "code": "CAL", | "code": "CAL", |
| "name": "Calligraphy", | "name": "Calligraphy", |
| "academic-term": "/api/academic-terms/1", | "academic-term-type": "/api/academic-terms/types/1", |
| "credits": "3" | "credits": "3" |
| } | } |
| "revised": "2015-02-13T15:56:10+00:00", | "revised": "2015-02-13T15:56:10+00:00", |
| "course": "/api/courses/321", | "course": "/api/courses/321", |
| | "applicant": "/api/applicants/123", |
| "application": "/api/applications/123", | "application": "/api/applications/123", |
| "status": "Prepare" | "status": "Prepare" |
| } | } |
| |
| ==== Response example (applicant chooses subjects) ==== | ==== Response example (applicant chooses subjects) ==== |
| |
| "type": "UG", | "type": "UG", |
| "name": "Astronomy", | "name": "Astronomy", |
| "academic-term": "/api/academic-terms/1", | "academic-term-type": "/api/academic-terms/types/1", |
| "credits": "5" | "credits": "5" |
| }, | }, |
| "type": "UG", | "type": "UG", |
| "name": "Botany", | "name": "Botany", |
| "academic-term": "/api/academic-terms/1", | "academic-term-type": "/api/academic-terms/types/1", |
| "credits": "2" | "credits": "2" |
| }, | }, |
| "type": "UG", | "type": "UG", |
| "name": "Calligraphy", | "name": "Calligraphy", |
| "academic-term": "/api/academic-terms/1", | "academic-term-type": "/api/academic-terms/types/1", |
| "credits": "3" | "credits": "3" |
| } | } |
| "revised": "2015-02-13T15:56:10+00:00", | "revised": "2015-02-13T15:56:10+00:00", |
| "course": "/api/courses/321", | "course": "/api/courses/321", |
| | "applicant": "/api/applicants/123", |
| "application": "/api/applications/123", | "application": "/api/applications/123", |
| "status": "Prepare" | "status": "Prepare" |
| } | } |