Skip to content

Commit

Permalink
IVIS-46: - Update API chapter.
Browse files Browse the repository at this point in the history
  • Loading branch information
RuslanPopenko committed Oct 26, 2016
1 parent 1739aa4 commit 861b37a
Show file tree
Hide file tree
Showing 6 changed files with 92 additions and 23 deletions.
22 changes: 22 additions & 0 deletions docs/api/afterschoolcentersection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
List of properties from AfterSchoolCenterSection
================================================

#. id(NUMBER)
#. name(STRING)
#. school(OBJECT)
type of `School <http://docs.ivis.se/en/latest/api/school.html>`_

Example of response:
~~~~~~~~~~~~~~~~~~~~

.. code-block:: json
{
"id" : 0,
"name" : "",
"school" : {
"id" : null,
"name" : null,
"school_id" : null
}
}
23 changes: 0 additions & 23 deletions docs/api/afterschoolcentersections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Provides following method for `API <index.html>`_ calls:
* `Save afterSchoolCenterSections`_
* `Update afterSchoolCenterSection`_
* `Delete afterSchoolCenterSection`_
* `Get afterSchoolCenterSection or afterSchoolCenterSections by personal id`_
* `Get afterSchoolCenterSection or afterSchoolCenterSections by name`_

.. _`Get afterSchoolCenterSection`:
Expand Down Expand Up @@ -175,28 +174,6 @@ Parameters response:
.. note::
you receive deleted object

.. _`Get afterSchoolCenterSection or afterSchoolCenterSections by personal id`:

Get afterSchoolCenterSection or afterSchoolCenterSections by personal id
---------------------------------------------------------------------

URL:
~~~~
*/afterschoolcentersections
Method:
~~~~~~~
*GET*

Parameters request:
~~~~~~~~~~~~~~~~~~~
*personalId(STRING)*
*first(BOOLEAN)* - optional

Parameters response:
~~~~~~~~~~~~~~~~~~~~
*ARRAY or OBJECT (AfterSchoolCenterSection)*

.. _`Get afterSchoolCenterSection or afterSchoolCenterSections by name`:

Get afterSchoolCenterSection or afterSchoolCenterSections by name
Expand Down
18 changes: 18 additions & 0 deletions docs/api/diary.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
List of properties from Diary
=============================

#. day_of_week (STRING)
can be only "MONDAY" .. "SUNDAY"
#. start_time (STRING)
#. end_time (STRING)

Example of response:
~~~~~~~~~~~~~~~~~~~~

.. code-block:: json
{
"day_of_week": "MONDAY",
"start_time":"08:00:00",
"school_day_end":"15:00:00"
}
Empty file added docs/api/pupil.rst
Empty file.
23 changes: 23 additions & 0 deletions docs/api/school.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
List of properties from School
==============================

#. id(NUMBER)
#. name(STRING)
#. school_id(STRING)
#. school_classes(ARRAY)
type of `SchoolClass <http://docs.ivis.se/en/latest/api/schoolclass.html>`_
#. after_school_center_sections(ARRAY)
type of `AfterSchoolCenterSection <http://docs.ivis.se/en/latest/api/afterschoolcentersection.html>`_

Example of response:
~~~~~~~~~~~~~~~~~~~~

.. code-block:: json
{
"id" : 0,
"name" : "",
"school_id" : "",
"school_classes" : {},
"after_school_center_sections" : {}
}
29 changes: 29 additions & 0 deletions docs/api/schoolclass.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
List of properties from SchoolClass
===================================

#. id (NUMBER)
#. name (STRING)
#. school (OBJECT)
type of `School <http://docs.ivis.se/en/latest/api/school.html>`_
#. pupils (ARRAY)
type of `Pupil <http://docs.ivis.se/en/latest/api/pupil.html>`_
#. diaries (ARRAY)
type of `Diary <http://docs.ivis.se/en/latest/api/diary.html>`_
#. school_day_start (STRING)
#. school_day_end (STRING)

Example of response:
~~~~~~~~~~~~~~~~~~~~

.. code-block:: json
{
"id":10,
"name":"",
"school_day_start":"08:00:00",
"school_day_end":"15:00:00",
"school":{ },
"pupils":[ ],
"diaries":[ ],
"diary_list":[ ]
}

0 comments on commit 861b37a

Please sign in to comment.