Merge pull request #179 from tutorcruncher/countries-endpoint

added countries endpoint api docs

Author: PrenSJ2

data/actions.json

@@ -903,6 +903,13 @@
     "help_text": "When an Administrator exports data about Users.",
     "subject_types": []
   },
+  {
+    "key": "CLIENTS_EXPORT",
+    "value": "CLIENTS_EXPORT",
+    "msg": "Exported Clients",
+    "help_text": "When an Administrator exports data about Clients.",
+    "subject_types": []
+  },
   {
     "key": "EDITED_SYSTEM_SETTINGS",
     "value": "EDITED_SYSTEM_SETTINGS",

pages/api.yml

@@ -58,6 +58,10 @@ endpoint_sections:
     title: Contractors (Tutors)
     id: contractors
     layout: /contractors/contractors.yml
+  -
+    title: Countries
+    id: countries
+    layout: /countries/countries.yml
   -
     title: Enquiry
     id: enquiry

pages/countries/countries.yml

@@ -0,0 +1,24 @@
+sections:
+  -
+    title: Country Object
+    id: country-object
+    description: /countries/country-object.md
+    attributes: /countries/country-object.yml
+    response: /countries/get-a-country.json
+    response_title: OBJECT
+  -
+    title: List all Countries
+    id: list-all-countries
+    description: /countries/list-all-countries.md
+    code: /countries/list-all-countries.py
+    code_type: GET
+    code_url: /api/countries/
+    response: /countries/list-all-countries.json
+  -
+    title: Get a Country
+    id: get-a-country
+    description: /countries/get-a-country.md
+    code: /countries/get-a-country.py
+    code_type: GET
+    code_url: /api/countries/<id>/
+    response: /countries/get-a-country.json

pages/countries/country-object.md

@@ -0,0 +1,3 @@
+### Country Object
+
+The country object id is used, when creating and updating the user model. The country object is used to define the country of the user. 

pages/countries/country-object.yml

@@ -0,0 +1,25 @@
+attributes:
+  -
+    name: id
+    type: integer
+    description: Unique identifier for the object.
+  -
+    name: name
+    type: string
+    description: The name of the country.
+  -
+    name: abbreviation
+    type: string
+    description: The abbreviation of the country.
+  -
+    name: three_letter_iso
+    type: string
+    description: The three-letter ISO code for the country.
+  -
+    name: currency
+    type: string
+    description: The currency used in the country; e.g Pounds Sterling (£).
+  -
+    name: url
+    type: string
+    description: The URL of the country's object.

pages/countries/get-a-country.json

@@ -0,0 +1,7 @@
+{
+    "id": 183,
+    "name": "United Kingdom",
+    "abbreviation": "GB",
+    "three_letter_iso": "GBR",
+    "currency": "Pounds Sterling (£)"
+}

pages/countries/get-a-country.md

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

pages/countries/get-a-country.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/countries/list-all-countries.json

@@ -0,0 +1,32 @@
+{
+    "count": 4,
+    "next": null,
+    "previous": null,
+    "results": [
+        {
+            "id": 3,
+            "name": "Afghanistan",
+            "url": "http://localhost:8000/api/countries/3/"
+        },
+        {
+            "id": 5,
+            "name": "Albania",
+            "url": "http://localhost:8000/api/countries/5/"
+        },
+        {
+            "id": 48,
+            "name": "Algeria",
+            "url": "http://localhost:8000/api/countries/48/"
+        },
+        {
+            "id": 1,
+            "name": "Andorra",
+            "url": "http://localhost:8000/api/countries/1/"
+        },
+        {
+            "id": 7,
+            "name": "Angola",
+            "url": "http://localhost:8000/api/countries/7/"
+        }
+    ]
+}

pages/countries/list-all-countries.md

@@ -0,0 +1,3 @@
+### List all Countries
+
+Returns a list of your countries. The countries are sorted by name, alphabetically.