IVIS-46: - Update API chapter (schoolstransports and statuses).

docs/api/schooltransports.rst

@@ -0,0 +1,192 @@
+SchoolTransports
+================
+
+``(implementation of SchoolTransport entity)``
+
+Provides following method for `API <index.html>`_ calls:
+
+    * `Get schoolTransport`_
+    * `Get schoolTransports`_
+    * `Save schoolTransport`_
+    * `Save schoolTransports`_
+    * `Update schoolTransport`_
+    * `Delete schoolTransport`_
+    * `Get schoolTransport or schoolTransports by name`_
+
+.. _`Get schoolTransport`:
+
+Get schoolTransport
+-------------------
+
+URL:
+~~~~
+    */schooltransports/{id}*
+
+Method:
+~~~~~~~
+    *GET*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *null*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *Object*
+
+    *With properties:*
+        #. id(NUMBER)
+        #. name(STRING)
+
+Example of response:
+~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: json
+
+    {
+      "id" : 0,
+      "name" : ""
+    }
+
+.. _`Get schooltransports`:
+
+Get schooltransports
+--------------------
+
+URL:
+~~~~
+    */schooltransports*
+
+Method:
+~~~~~~~
+    *GET*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *null*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *Array*
+
+.. seealso::
+
+    Array consists of objects from `Get schoolTransport`_ method
+
+Save schoolTransport
+--------------------
+
+URL:
+~~~~
+    */schooltransports*
+
+Method:
+~~~~~~~
+    *POST*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *OBJECT(SchoolTransport)*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *OBJECT(SchoolTransport)*
+
+Null properties:
+~~~~~~~~~~~~~~~~
+    *id*
+
+Save schooltransports
+---------------------
+
+URL:
+~~~~
+    */schooltransports*
+
+Method:
+~~~~~~~
+    *POST*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *Array(SchoolTransport)*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *Array(SchoolTransport)*
+Null properties of every object in array:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    *id*
+
+.. _`Update schoolTransport`:
+
+Update schoolTransport
+----------------------
+
+URL:
+~~~~
+    */schooltransports/{id}*
+
+Method:
+~~~~~~~
+    *PUT*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *OBJECT(SchoolTransport)*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *OBJECT(SchoolTransport)*
+
+.. note::
+
+    property will be updated, if you don't want update property it need set null
+
+.. _`Delete schoolTransport`:
+
+Delete schoolTransport
+----------------------
+
+URL:
+~~~~
+    */schooltransports/{id}*
+
+Method:
+~~~~~~~
+    *DELETE*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *null*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *OBJECT(SchoolTransport)*
+
+.. note::
+
+    you receive deleted object
+
+.. _`Get schoolTransport or schoolTransports by name`:
+
+Get schoolTransport or schoolTransports by name
+-----------------------------------------------
+
+URL:
+~~~~
+    */schooltransports*
+
+Method:
+~~~~~~~
+    *GET*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *name(STRING)*
+    and optional *first(BOOLEAN)*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *ARRAY or OBJECT (SchoolTransport)*
+

docs/api/statuses.rst

@@ -5,12 +5,17 @@ Statuses
 
 Provides following method for `API <index.html>`_ calls:
 
+    * `Get status`_
     * `Get statuses`_
+    * `Save status`_
+    * `Save statuses`_
+    * `Update status`_
+    * `Delete status`_
 
-.. _`Get statuses`:
+.. _`Get status`:
 
-Get statuses
-------------
+Get status
+----------
 
 URL:
 ~~~~
@@ -29,18 +34,136 @@ Parameters response:
     *Object*
 
     *With properties:*
-        #. id (Number)
-        #. name (String)
-
-.. note::
-    Property name has only values: "CREATING", "NEW", "ASSIGNED", "ARCHIVED"
+        #. id(NUMBER)
+        #. name(NULL)
 
 Example of response:
 ~~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: json
 
     {
-        "id":1,
-        "name" : "CREATING"
+      "id" : 0,
+      "name" : null
     }
+
+.. _`Get statuses`:
+
+Get statuses
+------------
+
+URL:
+~~~~
+    */statuses*
+
+Method:
+~~~~~~~
+    *GET*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *null*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *Array*
+
+.. seealso::
+
+    Array consists of objects from `Get status`_ method
+
+Save status
+-----------
+
+URL:
+~~~~
+    */statuses*
+
+Method:
+~~~~~~~
+    *POST*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *OBJECT(Status)*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *OBJECT(Status)*
+
+Null properties:
+~~~~~~~~~~~~~~~~
+    *id*
+
+Save statuses
+-------------
+
+URL:
+~~~~
+    */statuses*
+
+Method:
+~~~~~~~
+    *POST*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *Array(Status)*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *Array(Status)*
+Null properties of every object in array:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    *id*
+
+.. _`Update status`:
+
+Update status
+-------------
+
+URL:
+~~~~
+    */statuses/{id}*
+
+Method:
+~~~~~~~
+    *PUT*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *OBJECT(Status)*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *OBJECT(Status)*
+
+.. note::
+
+    property will be updated, if you don't want update property it need set null
+
+.. _`Delete status`:
+
+Delete status
+-------------
+
+URL:
+~~~~
+    */statuses/{id}*
+
+Method:
+~~~~~~~
+    *DELETE*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *null*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *OBJECT(Status)*
+
+.. note::
+
+    you receive deleted object
+