Changes between Version 1 and Version 2 of S3/S3XML

Timestamp:

07/19/11 07:14:33 (13 years ago)

Author:

Dominic König

Comment:

--

S3/S3XML

@@ -1 +1 @@
 [[TOC]]
-= S3XML - XML/JSON Format =
+= S3XML =
+
+S3XML is a generic RESTful data exchange interface for the S3 framework.
+
+It comes with a genuine XML data format, but also provides built-in data format conversion and transformation to support a variety of custom XML, JSON and CSV formats and schemas.
+
+== Minimum Requirements for Implementation ==
+
+=== Clients ===
+
+Interfaces which want to exchange data with S3XML interfaces must implement the following:
+
+  - an HTTP client which can perform GET and POST requests
+  - the native S3XML data format
+
+''Note:''
+
+  - Where the target interface has built-in support for data format conversion/transformation (as in S3), it is sufficient if the client implements an S3XML-compatible data format (XML, JSON or CSV).
+  - S3 comes with a number of built-in transformation stylesheets for some standard data formats. Where other formats shall be used, clients can also provide their own XSLT transformation stylesheets.
+
+=== Servers ===
+
+Interfaces which want to provide native S3XML capabilities (e.g. for Synchronization) must implement the following:
+
+  - an HTTP server interface accepting and performing GET, PUT and POST requests
+  - the RESTful API as described in this document
+  - the native S3XML data format
+
+Optionally they can provide:
+
+  - JSON/CSV to S3XML conversion
+  - S3XML to JSON/CSV conversion
+  - XSLT-1.0 transformation
+
+== Conventions ==
+
+=== Name Space ===
+
+Where a name space identifier for the native S3XML format is to be used, it shall be:
+
+  - "http://eden.sahanafoundation.org/S3XML"
+
+In the current implementation of S3, no name space identifier shall be used. This is though subject to change in future versions.
+
+=== Character Encoding ===
+
+XML documents to be used for S3XML can specify their character encoding in the XML header.
+
+Where JSON or CSV formats are used, they are expected to be UTF-8 encoded. S3XML interfaces can support other encodings for JSON/CSV, but this is not a requirement.
+
+All exported data are always UTF-8 encoded.
+
+=== URL format ===
+
+Data format extensions in URLs must be all-lowercase. Where uppercase characters are used, they are converted into lowercase.
+
+== Interface ==
+
+== XML Format ==
+
+=== Types of Sources ===
+
+=== Element Descriptions ===
+
+== JSON Format ==
+
+== CSV Format ==
+
+== Examples ==
 
   - see [wiki:S3XRC]