IVIS-46: - Update API chapter (fix method get list by criteria).

imCodePartnerAB · Oct 26, 2016 · 40e4bc7 · 40e4bc7
1 parent 687bb9b
commit 40e4bc7
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 6 deletions.
diff --git a/docs/api/incidents.rst b/docs/api/incidents.rst
@@ -275,17 +275,13 @@ Parameters request:
     * *search_text*
     * *order_by*
 
-.. note::
-
-    Now required for order_by only "title" and search criteria also title in Incident
-
 Parameters response:
 ~~~~~~~~~~~~~~~~~~~~
     *Array*
 
 .. note::
 
-    Array structure the same as `Get incidents`_
+    Now required for order_by only "title" and search criteria also title. Search mechanism use contain.
 
 
 

diff --git a/docs/api/issues.rst b/docs/api/issues.rst
@@ -252,5 +252,10 @@ Parameters request:
     * *search_text*
     * *order_by*
 
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *Array*
+
 .. note::
-Now required for order_by only "title" and search criteria also title in Issue
+
+    Now required for order_by only "title" and search criteria also title. Search mechanism use contain.
diff --git a/docs/api/persons.rst b/docs/api/persons.rst
@@ -12,6 +12,7 @@ Provides following method for `API <index.html>`_ calls:
     * `Update person`_
     * `Delete person`_
     * `Get person or persons by personal id`_
+    * `Get persons list`_ by some criteria
 
 .. _`Get person`:
 
@@ -224,4 +225,24 @@ Parameters response:
 ~~~~~~~~~~~~~~~~~~~~
     *ARRAY or OBJECT (Person)*
 
+.. _`Get persons list`:
 
+Get persons list
+----------------
+
+URL:
+~~~~
+    */persons*
+
+Method:
+~~~~~~~
+    *GET*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    * *search_text*
+    * *order_by*
+
+.. note::
+
+    Now required for order_by "first_name" and "last_name" search criteria first_name or last_name. Search mechanism use contain.