Changes between Version 47 and Version 48 of S3/S3XML

Timestamp:

07/20/11 10:06:35 (13 years ago)

Author:

Dominic König

Comment:

--

S3/S3XML

@@ -149 +149 @@
 The ''transform'' variable overrides any attached or built-in stylesheets, and attached stylesheets override built-in stylesheets. The ''.xml'' request URL extension is reserved for the native S3XML format, and must not use or accept any stylesheets.
 
+=== Error Handling ===
+
+The HTTP status code in the response indicates the success or failure of a request:
+
+||'''Status Code'''||'''Causes'''||'''Response Body'''||
+||200 OK||Success||results or JSON message||
+||400 BAD REQUEST||Syntax error or method not supported||JSON message||
+||401 UNAUTHORIZED||Authorization required||Clear text error||
+||403 FORBIDDEN||Insufficient permissions||Clear text error||
+||404 NOT FOUND||Non-existent Resource||Clear text error||
+||50x||Unrecoverable internal error||Clear text error||
+
+Where a JSON message is returned, it has the following structure:
+{{{
+  {
+    success= "True" | "False",
+    statuscode = "XXX",
+    message = "clear text error message",
+    tree = {
+      /* element tree */
+    }
+  }
+}}}
+
+The status code contains the HTTP status code.
+
+If there was an input element tree and it contained errors, a subtree with the invalid elements will be added to the JSON message ("tree"). This subtree is expressed in [#JSONFormat1 JSON Format]. Invalid elements will have an additional ''error'' attribute containing a clear-text error desription.
+
+By default, an import request will be rolled back and an HTTP 400 BAD REQUEST error be raised if the source contains any invalid data. You can override this behavior by using the ''ignore_errors'' URL variable (with any non-empty string, e.g. {{{?ignore_errors=True}}}) - invalid records would then just be skipped and the request would return a HTTP 200 OK, but the JSON message would however contain the error message and the element tree. The ''ignore_errors'' option is though meant for "dirty" data, e.g. cases where you need to import from a source but do not have permission and/or means to clean it up before import. Where possible, you should avoid ignore_errors and rather sanitize the source.
 == XML Format ==