IVIS-46: - Sort docs, add files.

docs/api/academicyears.rst

@@ -0,0 +1,192 @@
+AcademicYears
+=============
+
+``(implementation of AcademicYear entity)``
+
+Provides following method for `API <index.html>`_ calls:
+
+    * `Get academicYear`_
+    * `Get academicYears`_
+    * `Save academicYear`_
+    * `Save academicYears`_
+    * `Update academicYear`_
+    * `Delete academicYear`_
+    * `Get academicYear or academicYears by name`_
+
+.. _`Get academicYear`:
+
+Get academicYear
+----------------
+
+URL:
+~~~~
+    */academicyears/{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 academicyears`:
+
+Get academicyears
+-----------------
+
+URL:
+~~~~
+    */academicyears*
+
+Method:
+~~~~~~~
+    *GET*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *null*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *Array*
+
+.. seealso::
+
+    Array consists of objects from `Get academicYear`_ method
+
+Save academicYear
+-----------------
+
+URL:
+~~~~
+    */academicyears*
+
+Method:
+~~~~~~~
+    *POST*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *OBJECT(AcademicYear)*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *OBJECT(AcademicYear)*
+
+Null properties:
+~~~~~~~~~~~~~~~~
+    *id*
+
+Save academicyears
+------------------
+
+URL:
+~~~~
+    */academicyears*
+
+Method:
+~~~~~~~
+    *POST*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *Array(AcademicYear)*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *Array(AcademicYear)*
+Null properties of every object in array:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    *id*
+
+.. _`Update academicYear`:
+
+Update academicYear
+-------------------
+
+URL:
+~~~~
+    */academicyears/{id}*
+
+Method:
+~~~~~~~
+    *PUT*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *OBJECT(AcademicYear)*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *OBJECT(AcademicYear)*
+
+.. note::
+
+    property will be updated, if you don't want update property it need set null
+
+.. _`Delete academicYear`:
+
+Delete academicYear
+-------------------
+
+URL:
+~~~~
+    */academicyears/{id}*
+
+Method:
+~~~~~~~
+    *DELETE*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *null*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *OBJECT(AcademicYear)*
+
+.. note::
+
+    you receive deleted object
+
+.. _`Get academicYear or academicYears by name`:
+
+Get academicYear or academicYears by name
+-----------------------------------------
+
+URL:
+~~~~
+    */academicyears*
+
+Method:
+~~~~~~~
+    *GET*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *name(STRING)*
+    and optional *first(BOOLEAN)*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *ARRAY or OBJECT (AcademicYear)*
+

docs/api/activities.rst

@@ -8,6 +8,9 @@ Provides following methods for `API <index.html>`_ calls:
     * `Get activity`_
     * `Get activities`_
     * `Save activity`_
+    * `Save activities`_
+    * `Update activity`_
+    * `Delete activity`_
     * `Attach file to activity`_
     * `Download attached file`_
 
@@ -33,31 +36,49 @@ Parameters response:
     *Object*
 
     *With properties:*
-        #. id (Number)
-        #. description (String)
-        #. reported_date (Number)
-        #. reported_by (Object)
-        #. file_name (String)
-        #. issue (Object)
-
-.. note::
-
-    reported_by links with Person entity
-
-    reported_date represent as number of seconds since 1 Jan 1970 00:00:00 (UTC)
+        #. id(NUMBER)
+        #. description(STRING)
+        #. file_name(STRING)
+        #. issue(OBJECT)
+           type of `Issue <http://docs.ivis.se/en/latest/api/issue.html>`_
+        #. reported_date(NUMBER)
+        #. reported_by(OBJECT)
+           type of `Person <http://docs.ivis.se/en/latest/api/person.html>`_
 
 Example of response:
 ~~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: json
 
     {
-        "id":1,
-        "description":"Test",
-        "reported_date":1465828993000,
-        "reported_by":{},
-        "issue":{},
-        "file_name":"file.pdf",
+      "id" : 0,
+      "description" : "",
+      "file_name" : "",
+      "issue" : {
+        "id" : null,
+        "title" : null,
+        "description" : null,
+        "status" : null,
+        "responsible_person" : null,
+        "authorized_persons" : [ ],
+        "reported_date" : null,
+        "reported_by" : null,
+        "modified_by" : null,
+        "modified_date" : null,
+        "categories" : [ ],
+        "priority" : null,
+        "pupils" : [ ]
+      },
+      "reported_date" : 1477473027056,
+      "reported_by" : {
+        "id" : null,
+        "personal_id" : null,
+        "first_name" : null,
+        "last_name" : null,
+        "addresses" : { },
+        "emails" : { },
+        "phones" : { }
+      }
     }
 
 .. _`Get activities`:
@@ -82,24 +103,34 @@ Parameters response:
     *Array*
 
 .. seealso::
+
     Array consists of objects from `Get activity`_ method
 
-Example of response:
-~~~~~~~~~~~~~~~~~~~~
+Save activity
+-------------
 
-.. code-block:: json
+URL:
+~~~~
+    */activities*
 
-    [
-        {},
-        {},
-        ...
-        {}
-    ]
+Method:
+~~~~~~~
+    *POST*
 
-.. _`Save activity`:
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *OBJECT(Activity)*
 
-Save activity
--------------
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *OBJECT(Activity)*
+
+Null properties:
+~~~~~~~~~~~~~~~~
+    *id*
+
+Save activities
+---------------
 
 URL:
 ~~~~
@@ -111,33 +142,64 @@ Method:
 
 Parameters request:
 ~~~~~~~~~~~~~~~~~~~
-    *Object*
-
-    *With properties:*
-        #. description (String)
-        #. issue (Object)
+    *Array(Activity)*
 
 Parameters response:
 ~~~~~~~~~~~~~~~~~~~~
-    *Object*
+    *Array(Activity)*
+Null properties of every object in array:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    *id*
 
-    *On server fill properties*
-        #. id (Number)
-        #. reported_date (Number)
-        #. reported_by (Object)
+.. _`Update activity`:
+
+Update activity
+---------------
+
+URL:
+~~~~
+    */activities/{id}*
+
+Method:
+~~~~~~~
+    *PUT*
+
+Parameters request:
+~~~~~~~~~~~~~~~~~~~
+    *OBJECT(Activity)*
+
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *OBJECT(Activity)*
 
 .. note::
-    You retrieve whole object just like in `Get activity`_
 
-Example of request:
+    property will be updated, if you don't want update property it need set null
+
+.. _`Delete activity`:
+
+Delete activity
+---------------
+
+URL:
+~~~~
+    */activities/{id}*
+
+Method:
+~~~~~~~
+    *DELETE*
+
+Parameters request:
 ~~~~~~~~~~~~~~~~~~~
+    *null*
 
-.. code-block:: json
+Parameters response:
+~~~~~~~~~~~~~~~~~~~~
+    *OBJECT(Activity)*
 
-    {
-        "description" : "Test",
-        "issue" : { id : 1 }
-    }
+.. note::
+
+    you receive deleted object
 
 .. _`Attach file to activity`: