From: Bill Erickson <berickxx@gmail.com>
Date: Fri, 8 May 2015 20:01:17 +0000 (-0400)
Subject: web api preso cont.
X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=6dd28f8e98eb49b346b543309cea82f573472796;p=working%2Frandom.git

web api preso cont.

Signed-off-by: Bill Erickson <berickxx@gmail.com>
---

diff --git a/api_presentation/web_apis.asciidoc b/api_presentation/web_apis.asciidoc
index 41f23dc5a..fb04a3f60 100644
--- a/api_presentation/web_apis.asciidoc
+++ b/api_presentation/web_apis.asciidoc
@@ -16,11 +16,9 @@
   ** Fleshing
   ** Sorting, Limiting, Selecting Fields
   ** Anonymous Mode
- * Flat Fielder
+  ** Scripting
+ * Fielder / Flat Fielder
   ** IDL Elements / Field Safe
- * JS libs
-  ** fieldmapper.standardRequest()
-  ** egNet.request()
 
 == IDL : Evergreen DNA
 
@@ -268,6 +266,31 @@ egCore.pcrud.search('aou', {parent_ou : 1})
  * With web development in particular, sufficiently complex logic will
    be faster as an API call, since less data has to traverse the network.
 
+== Fielder
+
+[source,sh]
+---------------------------------------------------------------------------
+srfsh# request open-ils.fielder 
+    open-ils.fielder.aou {"query":{"id":{"!=":null}}}
+
+Received Data: {
+    "shortname":"SL1",
+    "holds_address":null,
+    "fiscal_calendar":1,
+    "parent_ou":4,
+    "opac_visible":"t",
+    "ou_type":4,
+    "billing_address":null,
+    "phone":null,
+    "mailing_address":null,
+    "email":null,
+    "id":8,
+    "name":"Example Sub-library 1",
+    "ill_address":null
+  }
+...
+---------------------------------------------------------------------------
+
 == Flat Fielder
 
 [source,js]
@@ -311,7 +334,13 @@ open-ils.fielder.flattened_search
 }
 ---------------------------------------------------------------------------
 
+== Fielder Notes and Limitations
 
+ * Read-only
+ * Flat fielder uses pcrud -- can access all pcrud-permissable data
+ * open-ils.fielder.<class> sits atop cstore -- public data only
+ * Implemented in Perl
+  ** Calls traverse Perl to cstore/pcrud
 
 == Questions / Comments