Changes between Version 15 and Version 16 of DeveloperGuidelines/Tutorial/RESTCustomisation

Timestamp:

03/03/14 20:48:04 (11 years ago)

Author:

Dominic König

Comment:

--

DeveloperGuidelines/Tutorial/RESTCustomisation

@@ -104 +104 @@
             # Similar, the ID of the requested record can be found in:
             record_id = r.id
+
+            # Being a S3Request instance, r contains a number of other important details
+            # to introspect the request, the requested resource, as well as useful helper
+            # functions for processing it
+            # Check: http://eden.sahanafoundation.org/wiki/S3/S3Request
 
             ...
@@ -131 +136 @@
 }}}
 
-== How to Authorize a Method ==
+== How to Authorize the Method ==
 
 When we implement a method handler that returns information, we need to request permission to do so:
@@ -159 +164 @@
 Note that "read" permission for the ''requested'' record (pr_group 5) is already checked ''before'' the method handler is called, so it does not need to be checked again. But for any other record from which we return information to the user, or any other method we intend to perform, we must first check permissions in the method handler.
 
-=== Configuring a Method Handler ===
+== Configuring the Method Handler ==
 
 Eventually, we need to tell the REST API which function/class to call for the ''available_shelters'' qualifier:
@@ -174 +179 @@
                                   *s3_metafields())
 
-        # Configure a custom method
+        # Configure the custom method:
+        # the "method" parameter defines the URL parameter needed to request this method (the method "name")
+
         self.set_method("pr", "group", method="available_shelters", action=AvailableShelters)
 
@@ -184 +191 @@
 
 Note that if the method handler is implemented as S3Method subclass, we do ''not'' need to instantiate it. It will be instantiated only when it is needed to process the request.
+
+== Put it on a Tab ==
+
+Now we want to see the list of available shelters on a ''component tab''.
+
+Component tabs are typically defined in the '''rheader''' function for the target table, so we check our ''rheader'' for ''pr_group'':
+
+{{{#!python
+
+    ...
+    elif resourcename == "group":
+
+        rheader_fields = [["name"],
+                          ["description"],
+                         ]
+
+        tabs = [("Group Details", None),
+                (T("Contact Data"), "contact"),
+                (T("Members"), "group_membership"),
+
+                # We add our custom method here:
+                (T("Find Shelter"), "available_shelters"),
+
+                ]
+    ...
+}}}
+
+That's it ;)