qualification api docs

Author: Pager07

pages/qual-levels/create-a-qual-level.json

@@ -0,0 +1,6 @@
+{
+    "id": 24,
+    "name": "A Level",
+    "ranking": 2.0,
+    "custom_to_branch": true
+}

pages/qual-levels/create-a-qual-level.md

@@ -0,0 +1,6 @@
+{
+    "id": 24,
+    "name": "A Level",
+    "ranking": 20.0,
+    "custom_to_branch": true
+}

pages/qual-levels/create-a-qual-level.py

@@ -0,0 +1,5 @@
+import pprint, requests
+data = {"name": "A Level",  "ranking":2}
+headers = {'Authorization': 'token <API KEY>'}
+r = requests.post('https://secure.tutorcruncher.com/api/qual_levels/',json=data, headers=headers)
+pprint.pprint(r.json())

pages/qual-levels/delete-a-qual-level.md

@@ -0,0 +1,2 @@
+### Delete a Qualification Level
+Deletes a Qualification Level created by the API key's Branch (custom_to_branch=True). Only the Qualification Level's unique id is required in the URL. Qualification Levels not created by the API key's Branch cannot be deleted.

pages/qual-levels/delete-a-qual-level.py

@@ -0,0 +1,4 @@
+import pprint, requests
+headers = {'Authorization': 'token <API KEY>'}
+r = requests.delete('https://secure.tutorcruncher.com/api/qual_levels/<id>/', headers=headers)
+pprint.pprint(r.json())

pages/qual-levels/get-a-qual-level.json

@@ -0,0 +1,6 @@
+{
+      "id": 5,
+      "name": "GCSE",
+      "ranking": 14.0,
+      "custom_to_branch": null
+}

pages/qual-levels/get-a-qual-level.md

@@ -0,0 +1,4 @@
+### Get a Qualification Level
+
+Returns the details of an existing Qualification Level. You only need to specify the unique
+`id` of the Qualification Level to get the correct details.

pages/qual-levels/get-a-qual-level.py

@@ -0,0 +1,5 @@
+import pprint, requests
+
+headers = {'Authorization': 'token <API KEY>'}
+r = requests.get('https://secure.tutorcruncher.com/api/qual_levels/<id>/', headers=headers)
+pprint.pprint(r.json())

pages/qual-levels/list-all-qual-levels.json

@@ -6,7 +6,8 @@
     {
       "id": 5,
       "name": "GCSE",
-      "ranking": 14.0
+      "ranking": 14.0,
+      "custom_to_branch": null
     },
     ...
   ]

pages/qual-levels/list-all-qual-levels.md

@@ -1,4 +1,3 @@
 ### List all Qualification Levels
 
-Returns of all the Qualification Levels found on your TutorCruncher account sorted by their `ids` with the
-largest id first.
+Returns all Qualification Levels, sorted by id in descending order (highest first). Includes Qualification Levels associated with the API key's Branch, as well as unassigned Qualification Levels (custom_to_branch = null). Qualification Levels linked to other Branches or marked as hidden for the API key's Branch are excluded.