Changes between Initial Version and Version 1 of barServiceGetCafInfo

Timestamp:

04/01/11 16:11:16 (15 years ago)

Author:

jkowalski

Comment:

--

barServiceGetCafInfo

@@ +1 @@
+= 3d Brain Atlas Reconstructor on-line service =
+
+== Service methods: ==
+
+=== getCafInfo ===
+
+Returns the index file of selected CAF dataset. Index file contains list of structures 
+available for reconstruction, their hierarchy and list of slides within given dataset.
+
+syntax:
+{{{
+getCafInfo?cafDatasetName=<name>
+         [;listStructures=(True|False)]
+         [;listHierarchy=(True|False)]
+         [;listSlides=(True|False)]
+}}}
+
+==== Required arguments ====
+* cafDatasetName - the name of the selected CAF dataset.
+    
+==== Optional arguments ====
+All optional arguments may be set to True or False with True as default.
+
+* listStructures - indicates if information about structures has to be included in the CAF index file.
+* listHierarchy - indicates if information about structures hierarchy has to be included in the CAF index file.
+* listSlides - indicates if information about slides has to be included.
+
+==== Examples ====
+* http://212.87.16.231:8080/getCafInfo?cafDatasetName=whs_0.51
+* http://212.87.16.231:8080/getCafInfo?cafDatasetName=whs_0.51&listSlides=False&listStructures=False