Changes between Version 78 and Version 79 of S3/S3XML

Timestamp:

10/22/14 19:28:42 (10 years ago)

Author:

Fran Boon

Comment:

--

S3/S3XML

@@ -190 +190 @@
 
 ==== Schema Documents ====
-
 '''Schema documents''' describe the data schema for a resource. Clients can use these documents e.g. for automatic generation of forms.
 
@@ -222 +221 @@
   - the URL query parameter {{{?options=true}}} adds a list of field options to those fields where options are defined, and combined with the parameter {{{&reference=true}}}, even options for foreign key references will be included
   - the URL query parameter {{{?meta=true}}} will include the meta fields (as <meta> elements). In data documents, the meta fields are to be encoded as attributes of the <resource> element
+
 ==== Field Option Documents ====
-
 '''Field option documents''' describe the currently acceptable options for fields in a resource. Clients can use these documents e.g. for automatic generation and/or client-side validation of forms.
 
@@ -246 +245 @@
   - In the current S3 implementation, transformation of field option documents is not supported. JSON conversion is possible, though.
   - Field option documents can only be requested (GET). Future versions may also accept submissions of such documents to update the data schema.
+
 ==== Data Documents ====
-
 '''Data documents''' provide the current contents (data) of resources.
 
@@ -275 +274 @@
 
 ==== Components ====
-
 Component resources are <resource> elements inside of their primary <resource> element.
 Component records will be automatically imported and the required key references be added (=no explicit reference-element required).
@@ -286 +284 @@
 
 ==== References ====
-
 Foreign key references (except those linking components to their primary record) are represented by <reference> elements.
 
@@ -300 +297 @@
 
 ==== s3xml ====
-
 The root element (in schema and data documents).
 
@@ -322 +318 @@
 ||'''limit'''||integer||the maximum number of records returned (in paginated requests)||''no''||
 ||'''latmin''', '''latmax''', '''lonmin''', '''lonmax'''||float||geo-location boundary box of the results||''no''||
+
 ==== resource ====
-
 Represents a record (in data documents) or a database table (in schema documents).
 
@@ -371 +367 @@
 
 MCI handling is optional for non-synchronizing interfaces.
+
 ==== data ====
-
 Represents the value of a single field in the record.
 
@@ -403 +399 @@
 
 ==== reference ====
-
 Represents a foreign key reference.
 
@@ -444 +439 @@
 == JSON Format ==
 To create new resources PUT to {{{http://host.domain/eden/module/resource.s3json}}}
+
+To introspect a form, GET {{{http://host.domain/eden/module/resource.s3json?options=true&references=true}}}
+
+JSON format characteristics:
+
+ * The JSON output contains _no_ whitespace between elements, it's just added here by hand for better readability
+
+ * The outermost structure is always a JSON object (not a list)
+ * All data is represented as strings (for security reasons)
+
+ * If @value is sent for a field, it overrides the element text ($) at import
+ * however, the use of @value is not mandatory, data can simply be placed instead of element text
+ * Note that there is no automatic data encoding: data must be sent in DB-encoded format
+ * no attributes are mandatory at input
+ * @tuid can be used instead of @uuid to link referenced records
+
+ * Multiple records of the same resource will be aggregated as lists like:
+
+{{{
+{
+    $_my_resource: [
+        {
+            // record1 of my_resource
+        }
+        {
+            // record2 of my_resource
+        }
+    ]
+}
+}}}
 
 Example of creating a Disease Case:
@@ -464 +489 @@
 }
 }}}
+
+
 == CSV Format ==
-
 The S3XML importer can represent uploaded single-sheet CSV files in a very simple XML format, whereby it becomes available for transformation into S3XML and import into Sahana-Eden.
 
@@ -496 +522 @@
 
 A number of pre-defined XSLT stylesheets for CSV import including a respective CSV template can be found in the static/formats/s3csv folder.
+
 == Examples ==
-
 === XML Format ===
 
@@ -563 +589 @@
 
 === JSON Format ===
-
 The data structure of the native S3JSON format is equivalent to the XML format (=element trees) - except that markup elements are represented by prefixes:
 
@@ -607 +632 @@
 }
 }}}
-
-'''JSON format characteristics:'''
-
-  * The JSON output contains _no_ whitespace between elements, it's just added here by hand for better readability
-
-  * The outermost structure is always a JSON object (not a list)
-  * All data is represented as strings (for security reasons)
-
-  * If @value is sent for a field, it overrides the element text ($) at import
-  * however, the use of @value is not mandatory, data can simply be placed instead of element text
-  * Note that there is no automatic data encoding: data must be sent in DB-encoded format
-  * no attributes are mandatory at input
-  * @tuid can be used instead of @uuid to link referenced records
-
-  * Multiple records of the same resource will be aggregated as lists like:
-
-{{{
-{
-    $_my_resource: [
-        {
-            // record1 of my_resource
-        }
-        {
-            // record2 of my_resource
-        }
-    ]
-}
-}}}