Changes between Initial Version and Version 1 of barServiceGetAvailableDatasets

Timestamp:

03/07/12 11:50:00 (12 years ago)

Author:

jkowalski

Comment:

--

barServiceGetAvailableDatasets

@@ +1 @@
+= 3d Brain Atlas Reconstructor on-line service =
+
+=== getAvailableDatasets ===
+
+Returns an AJAX data describing CAF datasets (atlases) available to the user in the service.
+
+ syntax::
+{{{
+getAvailableDatasets
+}}}
+
+==== AJAX data type ====
+{{{
+{
+  String: [String,
+           String,
+           String,
+           String,
+           {
+             String: Boolean,
+             ...
+           },
+           String],
+  ...
+}
+}}}
+      
+==== AJAX data description ====
+
+The data is provided in format:
+{{{
+{
+  <id>: [<name>,
+         <root>,
+         <description>,
+         <date>,
+         {
+           "cafslides": <cafslides>,
+           "reconstructions": <reconstructions>,
+           "thumbnails": <thumbnails>,
+           "customreconstruction": <customreconstruction>,
+           "hidden": <hidden>,
+           "internal": <internal>,
+           "enabled": true
+         },
+         <unit>],
+  ...
+}
+}}}
+where:
+
+ <id>:: is the atlas identifier in the service,
+
+ <name>:: is the atlas name,
+
+ <root>:: is the name of the root element in the atlas structures hierarchy tree,
+
+ <description>:: is the atlas description,
+
+ <date>:: is the CAF dataset compilation date,
+
+ <cafslides>:: indicates if CAF slides are available,
+
+ <reconstructions>:: indicates if reconstructions of structures in the atlas are available,
+
+ <thumbnails>:: indicates if thumbnail images of structures in the atlas are available,
+
+ <customreconstruction>:: indicates if it is possible to submit custom reconstruction of structures in the atlas,
+
+ <hidden>:: indicates if the dataset is invisible in the front-end interface,
+
+ <internal>:: indicates if access to the dataset is restricted to limited group of users.
+
+
+==== Example ====
+* http://service.3dbar.org/getAvailableDatasets