subjects api docs

Author: Pager07

pages/subjects/create-a-subject.json

@@ -0,0 +1,7 @@
+{
+    "id": 168,
+    "name": "Statistic",
+    "category_id": 14,
+    "category_name": "Science",
+    "custom_to_branch": true
+}

pages/subjects/create-a-subject.md

@@ -0,0 +1,3 @@
+### Create a Subject 
+Creates a new Subject with the given `name` and `category`, linked to the request user's Branch (`custom_to_branch`=True).
+

pages/subjects/create-a-subject.py

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

pages/subjects/delete-a-subject.md

@@ -0,0 +1,2 @@
+### Delete a Subject
+Deletes a Subject created by the user's Branch (`custom_to_branch`=True). Only the Subject's unique id is required in the URL. Subjects not created by the user's Branch cannot be deleted.

pages/subjects/delete-a-subject.py

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

pages/subjects/get-a-subject.json

@@ -0,0 +1,7 @@
+{
+    "id": 168,
+    "name": "Statistic",
+    "category_id": 14,
+    "category_name": "Science",
+    "custom_to_branch": true
+}

pages/subjects/get-a-subject.md

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

pages/subjects/get-a-subject.py

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

pages/subjects/list-all-subjects.json

@@ -7,7 +7,8 @@
       "id": 22,
       "name": "Computer Science",
       "category_id": 4,
-      "category_name": "Engineering"
+      "category_name": "Engineering",
+      "custom_to_branch": null
     },
     ...
   ]

pages/subjects/list-all-subjects.md

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