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


Ignore:
Timestamp:
10/28/10 09:57:52 (11 years ago)
Author:
Dominic König
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • S3/S3REST/URLFormat

    v8 v9  
    88  - ''Parts in { } mark optional parts, [ A | B ] indicates alternatives''
    99
    10 The basic URL format is: /'''prefix'''/'''name'''{ /<'''arguments'''> }{ ?<'''query'''> }
     10The basic URL format is:
    1111
    12   * '''prefix''' is the resource prefix (="module" name)
    13   * '''name''' is the resource name (without prefix)
     12  ''!http:// server / path'' / '''prefix''' / '''name'''{ /<'''arguments'''> }{ ?<'''query'''> }
    1413
    15   * '''arguments''' is a list of: { /'''id''' }{ / [ '''method''' | '''component''' { /'''component_id''' } { /'''method''' } ] }
    16     * '''id''' is a record ID in the main resource
    17     * '''component''' is a component resource name (without prefix)
    18     * '''component_id''' is a record ID in the component resource
    19     * '''method''' is a URL method (only in GET/POST requests, e.g. "create", "update" or "delete")
     14  ''Example:''
     15  {{{
     16http://vita.sahanafoundation.org/eden/hms/hospital/1/bed_capacity/create
     17  }}}
    2018
    21   * '''query''' syntax see below
     19  * server ({{{/eden}}}) is the server ({{{vita.sahanafoundation.org}}}), path the path to the application
    2220
     21  * '''prefix''' ('''{{{/hms}}}''') is the application prefix (="module" name) of the resource
     22  * '''name''' ('''{{{/hospital}}}''') is the resource name (without prefix)
     23
     24The '''arguments''' list consists of:
     25
     26  { /'''id''' }{ / [ '''method''' | '''component''' { /'''component_id''' } { /'''method''' } ] }
     27
     28  * '''id''' ('''{{{/1}}}''') is a record ID in the main resource
     29  * '''component''' ('''{{{/bed_capacity}}}''') is a component resource name (without prefix)
     30  * '''component_id''' is a record ID in the component resource
     31  * '''method''' ('''{{{/create}}}''') is a URL [wiki:S3XRC/RESTfulAPI/Methods method]
     32
     33For the '''query''' syntax, see below
    2334== Basic Query Format ==
    2435