Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Last revisionBoth sides next revision
api:api_applications_id_studyplans_id [2015/02/13 16:25] – [Insert vs Select] Lauri Elevantapi:api_applications_id_studyplans_id [2016/06/01 14:48] – [Explanation of data] Lauri Elevant
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 studyplan vs Select subjects ====+==== 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. 
Line 21: Line 21:
   * ''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).
Line 51: 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 57: 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 63: 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 70: 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",     "application": "/api/applications/123",
     "status": "Prepare"     "status": "Prepare"
   }   }
- 
 ==== Response example (applicant chooses subjects) ==== ==== Response example (applicant chooses subjects) ====
  
Line 82: Line 82:
             "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"
         },         },
Line 89: Line 89:
             "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"
         },         },
Line 96: Line 96:
             "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"
         }         }
Line 103: Line 103:
     "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"
   }   }