Merge pull request #199 from tutorcruncher/subject-cat-endpoint

Add subject cat docs

Author: HenryTraill

data/actions.json

@@ -914,6 +914,14 @@
       "Application"
     ]
   },
+  {
+    "key": "EXPORTED_TENDERS",
+    "value": "EXPORTED_TENDERS",
+    "msg": "Exported Job Applications",
+    "help_text": "When an admin exports Job Applications.",
+    "extra_msg": "",
+    "subject_types": []
+  },
   {
     "key": "CREATED_AN_APPOINTMENT",
     "value": "CREATED_AN_APPOINTMENT",
@@ -1732,7 +1740,15 @@
     "key": "DELETED_A_REVIEW",
     "value": "DELETED_A_REVIEW",
     "msg": "Deleted a Review",
-    "help_text": "When an Administrator deletes a Client's Reivew.",
+    "help_text": "When an Administrator deletes a Client's Review.",
+    "extra_msg": "",
+    "subject_types": []
+  },
+  {
+    "key": "EXPORTED_REVIEWS",
+    "value": "EXPORTED_REVIEWS",
+    "msg": "Exported Reviews",
+    "help_text": "When an Administrator exports Reviews",
     "extra_msg": "",
     "subject_types": []
   },

pages/api.yml

@@ -130,6 +130,10 @@ endpoint_sections:
     title: Subjects
     id: subjects
     layout: /subjects/subjects.yml
+  -
+    title: Subject Categories
+    id: subject-categories
+    layout: /subject-categories/subject-categories.yml
   -
     title: Tasks
     id: tasks

pages/subject-categories/get-a-subject-category.json

@@ -0,0 +1,4 @@
+{
+    "id": 51,
+    "name": "Science"
+  }

pages/subject-categories/get-a-subject-category.md

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

pages/subject-categories/get-a-subject-category.py

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

pages/subject-categories/list-all-subject-categories.json

@@ -0,0 +1,15 @@
+{
+  "count": 2,
+  "next": null,
+  "previous": null,
+  "results": [
+      {
+          "id": 50,
+          "name": "Maths"
+      },
+      {
+          "id": 51,
+          "name": "Science"
+      }
+  ]
+}

pages/subject-categories/list-all-subject-categories.md

@@ -0,0 +1,3 @@
+### List all Subject Categories
+
+Returns of all the Subject Categories found on your TutorCruncher account, which are sorted by `id`.

pages/subject-categories/list-all-subject-categories.py

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

pages/subject-categories/subject-categories.yml

@@ -0,0 +1,24 @@
+sections:
+  -
+    title: Subject Category Object
+    id: subject-category-object
+    description: /subject-categories/subject-category.md
+    attributes: /subject-categories/subject-category.yml
+    response: /subject-categories/subject-category.json
+    response_title: OBJECT
+  -
+    title: List all Subject Categories
+    id: list-all-subject-categories
+    description: /subject-categories/list-all-subject-categories.md
+    code: /subject-categories/list-all-subject-categories.py
+    code_type: GET
+    code_url: /api/subject-categories/
+    response: /subject-categories/list-all-subject-categories.json
+  -
+    title: Get a Subject Category
+    id: get-a-subject-category
+    description: /subject-categories/get-a-subject-category.md
+    code: /subject-categories/get-a-subject-category.py
+    code_type: GET
+    code_url: /api/subject-categories/<id>/
+    response: /subject-categories/get-a-subject-category.json

pages/subject-categories/subject-category.json

@@ -0,0 +1,4 @@
+{
+  "id": 51,
+  "name": "Science"
+}