Differences

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

Link to this comparison view

Next revision
Previous revision
api:api_applications_id_studyplans [2015/02/13 15:57]
Lauri Elevant created
api:api_applications_id_studyplans [2021/01/21 12:51] (current)
Line 3: Line 3:
 ===== HEAD, GET ===== ===== HEAD, GET =====
  
-Get a list of studyplans that have been attached to this application. The ''HEAD'' verb is useful if you only want to test if this application has any study plans attached at all (and how many). Use the ''GET'' verb to get the listing of study plans.+Get a list of study plans that have been attached to this application. The ''HEAD'' verb is useful if you only want to test if this application has any study plans attached at all (and how many). Use the ''GET'' verb to get the listing of study plans.
  
 Note that an applicant may have more study plans, but only a subset of them may be attached to this particular application. Use the [[api:api_applicants_ID_studyplans|/api/applicants/ID/studyplans]] call to see all of the study plans that have been created by an applicant regardless of application. Note that an applicant may have more study plans, but only a subset of them may be attached to this particular application. Use the [[api:api_applicants_ID_studyplans|/api/applicants/ID/studyplans]] call to see all of the study plans that have been created by an applicant regardless of application.
  
-A study plan is always created for a particular course (you can see the course identifeir in the example data below). The statuses can currently be: 'Blank','Prepare','Completed','Accepted','Closed'+**To see the complete data for a study plan**, including the subjects selected, query the study plan by it's ID using [[api:api_applications_ID_studyplans_ID|/api/applications/ID/studyplans/ID]]. 
 + 
 +A study plan is always created in a particular application and are related to a particular course. 
 + 
 +The statuses can currently be: 
 +  * Blank 
 +  * Prepare 
 +  * Completed 
 +  * Accepted 
 +  * Closed 
  
 ==== Syntax ==== ==== Syntax ====
Line 29: Line 39:
         "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"
     }     }
   }   }