IVIS-46: - Update API chapter (guardians).

docs/api/academicyear.rst

@@ -0,0 +1,15 @@
+List of properties from AcademicYear
+====================================
+
+        #. id(NUMBER)
+        #. name(STRING)
+
+Example of response:
+~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: json
+
+    {
+      "id" : 0,
+      "name" : ""
+    }

docs/api/afterschoolcenterschema.rst

@@ -0,0 +1,21 @@
+List of properties from AfterSchoolCenterSchema
+===============================================
+
+        #. after_school_section(Object)
+            type of `AfterSchoolCenterSection <http://docs.ivis.se/en/latest/api/afterschoolcentersection.html>`_
+        #. day_of_week(STRING)
+            Only can be "MONDAY" .. "SUNDAY"
+        #. use_before_school(BOOLEAN)
+        #. use_after_school(BOOLEAN)
+
+Example of response:
+~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: json
+
+    {
+        "after_school_section" : {},
+        "day_of_week" : "MONDAY",
+        "use_before_school" : false,
+        "use_after_school" : false
+    }

docs/api/guardian.rst

@@ -0,0 +1,27 @@
+List of properties from Guardian
+================================
+
+        #. id(NUMBER)
+        #. person(OBJECT)
+           type of `Person <http://docs.ivis.se/en/latest/api/person.html>`_
+        #. pupils(ARRAY)
+           type of `Pupil <http://docs.ivis.se/en/latest/api/pupil.html>`_
+
+Example of response:
+~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: json
+
+    {
+      "id" : 0,
+      "person" : {
+        "id" : null,
+        "personal_id" : null,
+        "first_name" : null,
+        "last_name" : null,
+        "addresses" : { },
+        "emails" : { },
+        "phones" : { }
+      },
+      "pupils" : [ ]
+    }

docs/api/guardians.rst

@@ -11,8 +11,6 @@ Provides following method for `API <index.html>`_ calls:
     * `Save guardians`_
     * `Update guardian`_
     * `Delete guardian`_
-    * `Get guardian or guardians by personal id`_
-    * `Get guardian or guardians by name`_
 
 .. _`Get guardian`:
 
@@ -40,7 +38,7 @@ Parameters response:
         #. person(OBJECT)
            type of `Person <http://docs.ivis.se/en/latest/api/person.html>`_
         #. pupils(ARRAY)
-           type of `pupils <http://docs.ivis.se/en/latest/api/pupil.html>`_
+           type of `Pupil <http://docs.ivis.se/en/latest/api/pupil.html>`_
 
 Example of response:
 ~~~~~~~~~~~~~~~~~~~~
@@ -83,8 +81,8 @@ Parameters response:
     *Array*
 
 .. seealso::
-    
-Array consists of objects from `Get guardian`_ method
+
+    Array consists of objects from `Get guardian`_ method
 
 Save guardian
 -------------
@@ -153,8 +151,8 @@ Parameters response:
     *OBJECT(Guardian)*
 
 .. note::
-    
-property will be updated, if you don't want update property it need set null
+
+    property will be updated, if you don't want update property it need set null
 
 .. _`Delete guardian`:
 
@@ -178,49 +176,8 @@ Parameters response:
     *OBJECT(Guardian)*
 
 .. note::
-    you receive deleted object
-
-.. _`Get guardian or guardians by personal id`:
-
-Get guardian or guardians by personal id
--------------------------------------
-
-URL:
-~~~~
-    */guardians
 
-Method:
-~~~~~~~
-    *GET*
-
-Parameters request:
-~~~~~~~~~~~~~~~~~~~
-    *personalId(STRING)*
-    *first(BOOLEAN)* - optional
-
-Parameters response:
-~~~~~~~~~~~~~~~~~~~~
-    *ARRAY or OBJECT (Guardian)*
-
-.. _`Get guardian or guardians by name`:
-
-Get guardian or guardians by name
----------------------------------
-
-URL:
-~~~~
-    */guardians
-
-Method:
-~~~~~~~
-    *GET*
+    you receive deleted object
 
-Parameters request:
-~~~~~~~~~~~~~~~~~~~
-    *name(STRING)*
-    *first(BOOLEAN)* - optional
 
-Parameters response:
-~~~~~~~~~~~~~~~~~~~~
-    *ARRAY or OBJECT (Guardian)*
 

docs/api/pupil.rst

@@ -0,0 +1,24 @@
+List of properties from Pupil
+=============================
+
+        #. id(NUMBER)
+        #. person(OBJECT)
+           type of `Person <http://docs.ivis.se/en/latest/api/person.html>`_
+        #. contact_person(OBJECT)
+           type of `Person <http://docs.ivis.se/en/latest/api/person.html>`_
+        #. class_placement_from(NUMBER)
+        #. class_placement_to(NUMBER)
+        #. school_class(OBJECT)
+            type of `SchoolClass <http://docs.ivis.se/en/latest/api/schoolclass.html>`_
+        #. school
+           type of `School <http://docs.ivis.se/en/latest/api/school.html>`_
+        #. academic_year(OBJECT)
+           type of `AcademicYear <http://docs.ivis.se/en/latest/api/academicyear.html>`_
+        #. guardians(ARRAY)
+           type of `Guardian <http://docs.ivis.se/en/latest/api/guardian.html>`_
+        #. truancies(ARRAY)
+           type of `Truancy <http://docs.ivis.se/en/latest/api/truancy.html>`_
+        #. after_school_center_section(OBJECT)
+           type of `AfterSchoolCenterSection <http://docs.ivis.se/en/latest/api/afterschoolcentersection.html>`_
+        #. school_center_schema(ARRAY)
+           type of `AfterSchoolCenterSchema <http://docs.ivis.se/en/latest/api/afterschoolcenterschema.html>`_

docs/api/truancy.rst

@@ -0,0 +1,40 @@
+List of properties from Truancy
+===============================
+
+        #. id(NUMBER)
+        #. pupil(OBJECT)
+           type of `Pupil <http://docs.ivis.se/en/latest/api/pupil.html>`_
+        #. start_date(NUMBER)
+        #. end_date(NUMBER)
+
+Example of response:
+~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: json
+
+    {
+      "id" : 0,
+      "pupil" : {
+        "id" : null,
+        "person" : {
+          "id" : null,
+          "personal_id" : null,
+          "first_name" : null,
+          "last_name" : null,
+          "addresses" : { },
+          "emails" : { },
+          "phones" : { }
+        },
+        "contact_person" : null,
+        "class_placement_from" : null,
+        "class_placement_to" : null,
+        "school_class" : null,
+        "school" : null,
+        "academic_year" : null,
+        "guardians" : [ ],
+        "after_school_center_section" : null,
+        "school_center_schema" : [ ]
+      },
+      "start_date" : 1477474352801,
+      "end_date" : 1477474352801
+    }