Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
api:api_applications_id_studyplans_id [2015/02/13 16:11]
Lauri Elevant
api:api_applications_id_studyplans_id [2016/06/01 14:48]
Lauri Elevant [Response example (applicant chooses subjects)]
Line 3: Line 3:
 ===== 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 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. 
 +
 +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.
  
  
Line 14: Line 23:
   * ''academic-year'' holds an identifier to a resource describing the academic year (Fall,Spring etc.).   * ''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.   * ''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).
  
 The statuses can currently be: The statuses can currently be:
Line 34: Line 44:
   Content-Length: 1234   Content-Length: 1234
      
-==== Response example ====+==== Response example (applicant inserts subjects) ====
  
   {   {
Line 41: Line 51:
             "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"
         },         },
Line 47: Line 57:
             "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"
         },         },
Line 53: Line 63:
             "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"
         }         }
Line 60: Line 70:
     "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",
 +    "status": "Prepare"
 +  }
 +==== Response example (applicant chooses subjects) ====
 +
 +  {
 +    "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",     "application": "/api/applications/123",
     "status": "Prepare"     "status": "Prepare"
   }   }