Changes between Version 8 and Version 9 of S3/S3REST/URLFormat

Timestamp:

10/28/10 09:57:52 (14 years ago)

Author:

Dominic König

Comment:

--

S3/S3REST/URLFormat

@@ -8 +8 @@
   - ''Parts in { } mark optional parts, [ A | B ] indicates alternatives''
 
-The basic URL format is: /'''prefix'''/'''name'''{ /<'''arguments'''> }{ ?<'''query'''> }
+The basic URL format is:
 
-  * '''prefix''' is the resource prefix (="module" name)
-  * '''name''' is the resource name (without prefix)
+  ''!http:// server / path'' / '''prefix''' / '''name'''{ /<'''arguments'''> }{ ?<'''query'''> }
 
-  * '''arguments''' is a list of: { /'''id''' }{ / [ '''method''' | '''component''' { /'''component_id''' } { /'''method''' } ] }
-    * '''id''' is a record ID in the main resource
-    * '''component''' is a component resource name (without prefix)
-    * '''component_id''' is a record ID in the component resource
-    * '''method''' is a URL method (only in GET/POST requests, e.g. "create", "update" or "delete")
+  ''Example:''
+  {{{
+http://vita.sahanafoundation.org/eden/hms/hospital/1/bed_capacity/create
+  }}}
 
-  * '''query''' syntax see below
+  * server ({{{/eden}}}) is the server ({{{vita.sahanafoundation.org}}}), path the path to the application 
 
+  * '''prefix''' ('''{{{/hms}}}''') is the application prefix (="module" name) of the resource 
+  * '''name''' ('''{{{/hospital}}}''') is the resource name (without prefix)
+
+The '''arguments''' list consists of:
+
+  { /'''id''' }{ / [ '''method''' | '''component''' { /'''component_id''' } { /'''method''' } ] }
+
+  * '''id''' ('''{{{/1}}}''') is a record ID in the main resource 
+  * '''component''' ('''{{{/bed_capacity}}}''') is a component resource name (without prefix) 
+  * '''component_id''' is a record ID in the component resource
+  * '''method''' ('''{{{/create}}}''') is a URL [wiki:S3XRC/RESTfulAPI/Methods method] 
+
+For the '''query''' syntax, see below
 == Basic Query Format ==