Merge pull request #183 from tutorcruncher/contractor-distance

Add user list distance filter section

Author: HenryTraill

pages/api.yml

@@ -16,6 +16,10 @@ info_sections:
     title: Creating/Updating Users
     id: creating-updating-users
     layout: /creating-updating-users/creating-updating-users.yml
+  -
+    title: Distance Filter on User Lists
+    id: distance-filter
+    layout: /distance-filter/distance-filter.yml
   -
     title: Custom Fields
     id: custom-fields

pages/contractors/contractor-object.yml

@@ -229,11 +229,11 @@ filters:
     type: string
     description: Filter by the Contractor's status.
   -
-    name: address
+    name: distance_address
     type: string
     description: Filter by the address.
   -
-    name: radius
+    name: distance_radius
     type: integer
     description: Filter by the radius of the address. This is used in conjunction with the `address` filter.
   -

pages/distance-filter/distance-filter-object.yml

@@ -0,0 +1,10 @@
+attributes:
+  -
+    name: distance_address
+    type: string
+    description: A URL-encoded string representing the starting location for the search. This must be specific (e.g., including city, postal code, and country) for accurate results. Ensure the address is properly URL-encoded.
+  -
+    name: distance_radius
+    type: integer
+    description: The radius in kilometers around the distance_address to filter users. Users outside this radius will not be included.
+

pages/distance-filter/distance-filter.md

@@ -0,0 +1,2 @@
+[Agents](#agents), [Clients](#clients), [Contractors](#contractors), [Recipients](#recipients) can be filtered based on their proximity 
+to a specific location using the distance_address and distance_radius parameters.

pages/distance-filter/distance-filter.py

@@ -0,0 +1,12 @@
+import pprint
+import requests
+from urllib.parse import urlencode
+
+headers = {'Authorization': 'token <API KEY>'}
+params = {
+    'distance_address': 'The Food Exchange, New Covent Garden Market, Nine Elms, London SW8 5EL, ENGLAND',
+    'distance_radius': 1
+}
+url = f"https://secure.tutorcruncher.com/api/contractors/?{urlencode(params)}"
+response = requests.get(url, headers=headers)
+pprint.pprint(response.json())

pages/distance-filter/distance-filter.yml

@@ -0,0 +1,6 @@
+sections:
+  -
+    description: /distance-filter/distance-filter.md
+    code: /distance-filter/distance-filter.py
+    attributes: /distance-filter/distance-filter-object.yml
+    code_type: POST