Changes between Version 10 and Version 11 of RESTController

Timestamp:

11/20/09 00:38:49 (15 years ago)

Author:

Dominic König

Comment:

--

RESTController

@@ -131 +131 @@
 
 The {{{response.s3.filter}}} provides a filter which is used in the list view to show the desired subset of records (note that the s3.crud_strings can also be customised - when done in the Controller like this, they are good for just this request).
-== Argument Lists ==
+== URL Argument Lists ==
 
-URL format:
+General URL format:
 
 {{{
@@ -141 +141 @@
 The argument list is interpreted as follows:
 
-  * '''empty argument list''' is a LIST attempt to the primary resource
-  * '''<id>''' is a READ attempt on the record #<id> of the primary resource
-  * '''<method>''' is a <method> attempt on the primary resource
-  * '''<method>/<id>''' is a <method> attempt on the record #<id> of the primary resource
-  * '''<id>/<joined_resource>''' is a LIST attempt to the joined resource for the record #<id> of the primary resource
-  * '''<joined_resource>?id_label=XXX''' is a LIST attempt to the joined resource for the record of the primary resource with that label
-  * '''<id>/<joined_resource>/<method>''' is a <method> attempt on the joined resource for the record #<id> of the primary resource
-  * '''<joined_resource>/<method>?id_label=XXX''' analogous.
+  * '''empty argument list''' accesses to all/any records of the resource
+  * '''<id>''' access to record #<id> of the resource
+  * '''<method>''' <method> access to all/any records of the resource
+  * '''<method>/<id>''' <method> access to the record #<id> of the resource
 
-You may even pass the record ID of the joined resource at the end of the arguments list to access a particular record - which would produce an error message if these two records do not belong together.
+  * '''<id>/<component>''' access to all/any component records of the record #<id> of the resource
+  * '''<id>/<component>/<method>''' <method> access to all/any component records for the record #<id> of the resource
+
+You may even pass a record ID for the component at the end of the arguments list to access a particular component record - which would produce an error message if these two records do not belong together.
 
 The data format of the request can be passed:
 
-  * as extension to the primary resource, e.g. http://localhost:8000/sahana/pr/person.xml/1
-  * as extension to the joined resource, e.g. http://localhost:8000/sahana/pr/person/1/address.xml
+  * as extension to the resource, e.g. http://localhost:8000/sahana/pr/person.xml/1
+  * as extension to the record ID, e.g. http://localhost:8000/sahana/pr/person/1.xml
+  * as extension to the component, e.g. http://localhost:8000/sahana/pr/person/1/address.xml
+  * as extension to the method, e.g. http://localhost:8000/sahana/pr/person/1/address/create.xml
   * as variable "format", e.g. http://localhost:8000/sahana/pr/person/1/address?format=xml
 
-  '''Policy:''' ''"?format="'' overrides ''joined resource extension'' overrides ''resource extension''
-
+  '''Policy:''' the rightmost extension is applied, ''?format='' overrides any extensions
 == Plug-In Resource Actions ==