Add documentation about JSON reports services to Web services chapter

diff --git a/source/11_reports.rst b/source/11_reports.rst
index 78561ca..35dadb7 100644 (file)
--- a/source/11_reports.rst
+++ b/source/11_reports.rst
@@ -35,15 +35,10 @@ generate a report.
 Step 1: Choose the module you want to report on. This will determine
 what tables and fields are available for you to query.
 
-'Report is public' should be left to the default of 'No' in most cases.
-A report can be made public if you intend to allow access to it through
-the JSON webservice interface. This is a system that can be used by
-developers to make custom presentations of the data from the report, for
-example displaying it using a graphing API. To learn more speak to your
-local developer.
-
--  A public report is accessible via a URL that looks like this:
-   http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID
+'Report is public' should be left to the default of 'No' in most cases 
+especially if the report contains patron or other sensitive information.
+A public report can be accessed using the :ref:`JSON reports services 
+<json-reports-services-label>` by anyone and without authentication.
 
 |image881|
 
@@ -167,15 +162,10 @@ Fill in the form presented
           you code should be fewer than 10 characters and should not
           include special characters or spaces.
 
--  'Report is public' should be left to the default of 'No' in most
-   cases. A report can be made public if you intend to allow access to
-   it through the JSON webservice interface. This is a system that can
-   be used by developers to make custom presentations of the data from
-   the report, for example displaying it using a graphing API. To learn
-   more speak to your local developer.
-
-   -  A public report is accessible via a URL that looks like this:
-      http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID
+-  'Report is public' should be left to the default of 'No' in most cases 
+    especially if the report contains patron or other sensitive information.
+    A public report can be accessed using the :ref:`JSON reports services 
+    <json-reports-services-label>` by anyone and without authentication.
 
 -  'Notes' will also appear on the Saved Reports page, this can be used
    to provide more details about the report or tips on how to enter

diff --git a/source/17_webservices.rst b/source/17_webservices.rst
index 8c2beda..7fd9781 100644 (file)
--- a/source/17_webservices.rst
+++ b/source/17_webservices.rst
@@ -96,3 +96,40 @@ Services provided in 1.4 version are:
                POST /suggestions
                PUT /suggestions/:suggestionid
                DELETE /suggestions/:suggestionid
+
+.. _json-reports-services-label:
+
+JSON reports services
+----------------------------------
+
+Koha implements a JSON reports service for every report saved
+using the :ref:`Guided Reports Wizard <guided-report-wizard-label>`
+or :ref:`Report from SQL <report-from-sql-label>` features.
+
+By default reports will be non-public and only accessible by authenticated
+users. If a report is explicitly set to *public* it will be accessible
+without authentication by anyone. This feature should only be used
+when the data can be shared safely not containing any patron information.
+
+The reports can be accessed using the following URLs:
+
+-  Public reports
+
+   -  OpacBaseURL/cgi-bin/koha/svc/report?id=REPORTID
+
+-  Non-public reports
+
+   -  StaffBaseURL/cgi-bin/koha/svc/report?id=REPORTID
+
+There are also some additional parameters available:
+
+-  Instead of accessing the report by REPORTID you can also use the 
+   report's name:
+
+   -  .../cgi-bin/koha/svc/report?name=REPORTNAME
+
+-  For easier development there is also an option to generate an
+   annotated output of the data. It will generate an array of hashes 
+   that include the field names as keys.
+
+   -  .../cgi-bin/koha/svc/report?name=REPORTNAME&annotated=1