IVIS-46: - Updated Information about services.

docs/api/allgroup.rst

@@ -4,26 +4,25 @@ ALL (list)
 .. toctree::
     :titlesonly:
 
-    academicyears
-    activities
-    afterschoolcentersections
-    applicationformquestiongroups
-    applicationformquestions
-    applicationforms
-    applicationformsteps
-    applications
-    categories
-    entityversions
-    guardians
-    incidents
-    issues
-    logevents
-    persons
-    priorities
-    pupils
-    roles
-    schoolclasses
-    schools
-    schooltransports
-    statuses
-    users
+    /services/academicyears
+    /services/activities
+    /services/afterschoolcentersections
+    /services/applicationformquestiongroups
+    /services/applicationformquestions
+    /services/applicationforms
+    /services/applicationformsteps
+    /services/applications
+    /services/categories
+    /services/entityversions
+    /services/guardians
+    /services/incidents
+    /services/issues
+    /services/logevents
+    /services/persons
+    /services/priorities
+    /services/pupils
+    /services/schoolclasses
+    /services/schools
+    /services/schooltransports
+    /services/statuses
+    /services/users

docs/api/applicationgroup.rst

@@ -4,10 +4,10 @@ APPLICATION
 .. toctree::
     :titlesonly:
 
-    applicationformquestiongroups
-    applicationformquestions
-    applicationforms
-    applicationformsteps
-    applications
-    entityversions
-    schooltransports
+    /services/applicationformquestiongroups
+    /services/applicationformquestions
+    /services/applicationforms
+    /services/applicationformsteps
+    /services/applications
+    /services/entityversions
+    /services/schooltransports

docs/api/basegroup.rst

@@ -4,11 +4,11 @@ BASE
 .. toctree::
     :titlesonly:
 
-    academicyears
-    afterschoolcentersections
-    guardians
-    persons
-    pupils
-    schoolclasses
-    schools
-    users
+    /services/academicyears
+    /services/afterschoolcentersections
+    /services/guardians
+    /services/persons
+    /services/pupils
+    /services/schoolclasses
+    /services/schools
+    /services/users

docs/api/entities/AcademicYear.rst

@@ -0,0 +1,4 @@
+List of properties from AcademicYear
+====================================
+        #. name(STRING)
+        #. id(NUMBER)

docs/api/entities/Activity.rst

@@ -0,0 +1,8 @@
+List of properties from Activity
+================================
+        #. description(STRING)
+        #. file_name(STRING)
+        #. issue(OBJECT< `Issue <http://docs.ivis.se/en/latest/api/entities/Issue.html>`_ >)
+        #. reported_date(NUMBER(Date representation wrapped))
+        #. reported_by(OBJECT< `Person <http://docs.ivis.se/en/latest/api/entities/Person.html>`_ >)
+        #. id(NUMBER)

docs/api/entities/Address.rst

@@ -0,0 +1,10 @@
+List of properties from Address
+===============================
+        #. postal_code(NUMBER)
+        #. municipality_code(STRING)
+        #. city(STRING)
+        #. street(STRING)
+        #. street2(STRING)
+        #. care_of(STRING)
+        #. type(OBJECT< `AddressTypeEnum <http://docs.ivis.se/en/latest/api/entities/AddressTypeEnum.html>`_ >)
+        #. value(STRING)

docs/api/entities/AddressTypeEnum.rst

@@ -0,0 +1,7 @@
+List of properties from AddressTypeEnum
+=======================================
+
+It is enum, that has STRING values.
+
+Values:
+    "REGISTERED", "RESIDENTIAL", "BOARDER".

docs/api/entities/AfterSchoolCenterSchema.rst

@@ -0,0 +1,6 @@
+List of properties from AfterSchoolCenterSchema
+===============================================
+        #. after_school_section(OBJECT< `AfterSchoolCenterSection <http://docs.ivis.se/en/latest/api/entities/AfterSchoolCenterSection.html>`_ >)
+        #. day_of_week(OBJECT< `DayOfWeek <http://docs.ivis.se/en/latest/api/entities/DayOfWeek.html>`_ >)
+        #. use_before_school(BOOLEAN)
+        #. use_after_school(BOOLEAN)

docs/api/entities/AfterSchoolCenterSection.rst

@@ -0,0 +1,5 @@
+List of properties from AfterSchoolCenterSection
+================================================
+        #. school(OBJECT< `School <http://docs.ivis.se/en/latest/api/entities/School.html>`_ >)
+        #. name(STRING)
+        #. id(NUMBER)

docs/api/entities/Application.rst

@@ -0,0 +1,11 @@
+List of properties from Application
+===================================
+        #. application_form(OBJECT< `ApplicationForm <http://docs.ivis.se/en/latest/api/entities/ApplicationForm.html>`_ >)
+        #. submitted_user(OBJECT< `User <http://docs.ivis.se/en/latest/api/entities/User.html>`_ >)
+        #. regarding_user(OBJECT< `User <http://docs.ivis.se/en/latest/api/entities/User.html>`_ >)
+        #. registration_number(NUMBER)
+        #. decision(OBJECT< `Decision <http://docs.ivis.se/en/latest/api/entities/Decision.html>`_ >)
+        #. handled_user(OBJECT< `Person <http://docs.ivis.se/en/latest/api/entities/Person.html>`_ >)
+        #. create_date(NUMBER(Date representation wrapped))
+        #. update_date(NUMBER(Date representation wrapped))
+        #. id(NUMBER)

docs/api/entities/ApplicationForm.rst

@@ -0,0 +1,7 @@
+List of properties from ApplicationForm
+=======================================
+        #. version(NUMBER)
+        #. steps(ARRAY< `ApplicationFormStep <http://docs.ivis.se/en/latest/api/entities/ApplicationFormStep.html>`_ >)
+        #. applications(ARRAY< `Application <http://docs.ivis.se/en/latest/api/entities/Application.html>`_ >)
+        #. name(STRING)
+        #. id(NUMBER)

docs/api/entities/ApplicationFormQuestion.rst

@@ -0,0 +1,13 @@
+List of properties from ApplicationFormQuestion
+===============================================
+        #. text(STRING)
+        #. value(STRING)
+        #. multi_values(BOOLEAN)
+        #. values(ARRAY<STRING>)
+        #. multi_variants(BOOLEAN)
+        #. variants(ARRAY<STRING>)
+        #. question_type(STRING)
+        #. question_group(OBJECT< `ApplicationFormQuestionGroup <http://docs.ivis.se/en/latest/api/entities/ApplicationFormQuestionGroup.html>`_ >)
+        #. sort_order(NUMBER)
+        #. name(STRING)
+        #. id(NUMBER)

docs/api/entities/ApplicationFormQuestionGroup.rst

@@ -0,0 +1,9 @@
+List of properties from ApplicationFormQuestionGroup
+====================================================
+        #. text(STRING)
+        #. questions(ARRAY< `ApplicationFormQuestion <http://docs.ivis.se/en/latest/api/entities/ApplicationFormQuestion.html>`_ >)
+        #. question_type(STRING)
+        #. step(OBJECT< `ApplicationFormStep <http://docs.ivis.se/en/latest/api/entities/ApplicationFormStep.html>`_ >)
+        #. sort_order(NUMBER)
+        #. name(STRING)
+        #. id(NUMBER)

docs/api/entities/ApplicationFormStep.rst

@@ -0,0 +1,8 @@
+List of properties from ApplicationFormStep
+===========================================
+        #. text(STRING)
+        #. question_groups(ARRAY< `ApplicationFormQuestionGroup <http://docs.ivis.se/en/latest/api/entities/ApplicationFormQuestionGroup.html>`_ >)
+        #. application_form(OBJECT< `ApplicationForm <http://docs.ivis.se/en/latest/api/entities/ApplicationForm.html>`_ >)
+        #. sort_order(NUMBER)
+        #. name(STRING)
+        #. id(NUMBER)

docs/api/entities/Category.rst

@@ -0,0 +1,4 @@
+List of properties from Category
+================================
+        #. name(STRING)
+        #. id(NUMBER)

docs/api/entities/CommunicationTypeEnum.rst

@@ -0,0 +1,7 @@
+List of properties from CommunicationTypeEnum
+=============================================
+
+It is enum, that has STRING values.
+
+Values:
+    "MOBILE", "WORK", "HOME".

docs/api/entities/DayOfWeek.rst

@@ -0,0 +1,7 @@
+List of properties from DayOfWeek
+=================================
+
+It is enum, that has STRING values.
+
+Values:
+    "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY".

docs/api/entities/Decision$Status.rst

@@ -0,0 +1,7 @@
+List of properties from Decision$Status
+=======================================
+
+It is enum, that has STRING values.
+
+Values:
+    "APPROVED", "DENIED", "HANDLED".

docs/api/entities/Decision.rst

@@ -0,0 +1,5 @@
+List of properties from Decision
+================================
+        #. status(OBJECT< `Decision$Status <http://docs.ivis.se/en/latest/api/entities/Decision$Status.html>`_ >)
+        #. date(NUMBER(Date representation wrapped))
+        #. comment(STRING)

docs/api/entities/Diary.rst

@@ -0,0 +1,5 @@
+List of properties from Diary
+=============================
+        #. day_of_week(OBJECT< `DayOfWeek <http://docs.ivis.se/en/latest/api/entities/DayOfWeek.html>`_ >)
+        #. start_time(NUMBER(Date representation wrapped))
+        #. end_time(NUMBER(Date representation wrapped))

docs/api/entities/Email.rst

@@ -0,0 +1,4 @@
+List of properties from Email
+=============================
+        #. type(OBJECT< `CommunicationTypeEnum <http://docs.ivis.se/en/latest/api/entities/CommunicationTypeEnum.html>`_ >)
+        #. value(STRING)

docs/api/entities/EntityVersion.rst

@@ -0,0 +1,7 @@
+List of properties from EntityVersion
+=====================================
+        #. timestamp(NUMBER(Date representation wrapped))
+        #. entity_class(STRING<ENTITY_CLASS_NAME>)
+        #. entity_id(NUMBER)
+        #. entity(NUMBER)
+        #. id(NUMBER)

docs/api/entities/Guardian.rst

@@ -0,0 +1,5 @@
+List of properties from Guardian
+================================
+        #. person(OBJECT< `Person <http://docs.ivis.se/en/latest/api/entities/Person.html>`_ >)
+        #. pupils(ARRAY< `Pupil <http://docs.ivis.se/en/latest/api/entities/Pupil.html>`_ >)
+        #. id(NUMBER)

docs/api/entities/Incident.rst

@@ -0,0 +1,18 @@
+List of properties from Incident
+================================
+        #. title(STRING)
+        #. description(STRING)
+        #. reported_date(NUMBER(Date representation wrapped))
+        #. categories(ARRAY< `Category <http://docs.ivis.se/en/latest/api/entities/Category.html>`_ >)
+        #. pupils(ARRAY< `Pupil <http://docs.ivis.se/en/latest/api/entities/Pupil.html>`_ >)
+        #. status(OBJECT< `Status <http://docs.ivis.se/en/latest/api/entities/Status.html>`_ >)
+        #. priority(OBJECT< `Priority <http://docs.ivis.se/en/latest/api/entities/Priority.html>`_ >)
+        #. issue(OBJECT< `Issue <http://docs.ivis.se/en/latest/api/entities/Issue.html>`_ >)
+        #. assigned_date(NUMBER(Date representation wrapped))
+        #. assigned_by(OBJECT< `Person <http://docs.ivis.se/en/latest/api/entities/Person.html>`_ >)
+        #. archived_date(NUMBER(Date representation wrapped))
+        #. archived_by(OBJECT< `Person <http://docs.ivis.se/en/latest/api/entities/Person.html>`_ >)
+        #. reported_by(OBJECT< `Person <http://docs.ivis.se/en/latest/api/entities/Person.html>`_ >)
+        #. modified_by(OBJECT< `Person <http://docs.ivis.se/en/latest/api/entities/Person.html>`_ >)
+        #. modified_date(NUMBER(Date representation wrapped))
+        #. id(NUMBER)

docs/api/entities/Issue.rst

@@ -0,0 +1,17 @@
+List of properties from Issue
+=============================
+        #. title(STRING)
+        #. description(STRING)
+        #. status(OBJECT< `Status <http://docs.ivis.se/en/latest/api/entities/Status.html>`_ >)
+        #. responsible_person(OBJECT< `Person <http://docs.ivis.se/en/latest/api/entities/Person.html>`_ >)
+        #. authorized_persons(ARRAY< `Person <http://docs.ivis.se/en/latest/api/entities/Person.html>`_ >)
+        #. incidents(ARRAY< `Incident <http://docs.ivis.se/en/latest/api/entities/Incident.html>`_ >)
+        #. reported_date(NUMBER(Date representation wrapped))
+        #. reported_by(OBJECT< `Person <http://docs.ivis.se/en/latest/api/entities/Person.html>`_ >)
+        #. modified_by(OBJECT< `Person <http://docs.ivis.se/en/latest/api/entities/Person.html>`_ >)
+        #. modified_date(NUMBER(Date representation wrapped))
+        #. activities(ARRAY< `Activity <http://docs.ivis.se/en/latest/api/entities/Activity.html>`_ >)
+        #. categories(ARRAY< `Category <http://docs.ivis.se/en/latest/api/entities/Category.html>`_ >)
+        #. priority(OBJECT< `Priority <http://docs.ivis.se/en/latest/api/entities/Priority.html>`_ >)
+        #. pupils(ARRAY< `Pupil <http://docs.ivis.se/en/latest/api/entities/Pupil.html>`_ >)
+        #. id(NUMBER)

docs/api/entities/LogEvent$Action.rst

@@ -0,0 +1,7 @@
+List of properties from LogEvent$Action
+=======================================
+
+It is enum, that has STRING values.
+
+Values:
+    "CREATE", "MODIFY", "DELETE".

docs/api/entities/LogEvent.rst

@@ -0,0 +1,11 @@
+List of properties from LogEvent
+================================
+        #. timestamp(NUMBER(Date representation wrapped))
+        #. entity_class_name(STRING)
+        #. entity_id(NUMBER)
+        #. action(OBJECT< `LogEvent$Action <http://docs.ivis.se/en/latest/api/entities/LogEvent$Action.html>`_ >)
+        #. field_name(STRING)
+        #. previous_value(STRING)
+        #. new_value(STRING)
+        #. user(OBJECT< `User <http://docs.ivis.se/en/latest/api/entities/User.html>`_ >)
+        #. id(NUMBER)

docs/api/entities/Person.rst

@@ -0,0 +1,9 @@
+List of properties from Person
+==============================
+        #. personal_id(STRING)
+        #. first_name(STRING)
+        #. last_name(STRING)
+        #. addresses(KEY_ENUM_OBJECT_PAIR< `AddressTypeEnum <http://docs.ivis.se/en/latest/api/entities/AddressTypeEnum.html>`_ ,`Address <http://docs.ivis.se/en/latest/api/entities/Address.html>`_ >)
+        #. emails(KEY_ENUM_OBJECT_PAIR< `CommunicationTypeEnum <http://docs.ivis.se/en/latest/api/entities/CommunicationTypeEnum.html>`_ ,`Email <http://docs.ivis.se/en/latest/api/entities/Email.html>`_ >)
+        #. phones(KEY_ENUM_OBJECT_PAIR< `CommunicationTypeEnum <http://docs.ivis.se/en/latest/api/entities/CommunicationTypeEnum.html>`_ ,`Phone <http://docs.ivis.se/en/latest/api/entities/Phone.html>`_ >)
+        #. id(NUMBER)

docs/api/entities/Phone.rst

@@ -0,0 +1,4 @@
+List of properties from Phone
+=============================
+        #. type(OBJECT< `CommunicationTypeEnum <http://docs.ivis.se/en/latest/api/entities/CommunicationTypeEnum.html>`_ >)
+        #. value(STRING)

docs/api/entities/Priority.rst

@@ -0,0 +1,4 @@
+List of properties from Priority
+================================
+        #. name(STRING)
+        #. id(NUMBER)

docs/api/entities/Pupil.rst

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

docs/api/entities/Role.rst

@@ -0,0 +1,6 @@
+List of properties from Role
+============================
+        #. internal(BOOLEAN)
+        #. user_role(BOOLEAN)
+        #. name(STRING)
+        #. id(NUMBER)

docs/api/entities/School.rst

@@ -0,0 +1,8 @@
+List of properties from School
+==============================
+        #. school_id(STRING)
+        #. services(ARRAY< `ServiceTypeEnum <http://docs.ivis.se/en/latest/api/entities/ServiceTypeEnum.html>`_ >)
+        #. school_classes(ARRAY< `SchoolClass <http://docs.ivis.se/en/latest/api/entities/SchoolClass.html>`_ >)
+        #. after_school_center_sections(ARRAY< `AfterSchoolCenterSection <http://docs.ivis.se/en/latest/api/entities/AfterSchoolCenterSection.html>`_ >)
+        #. name(STRING)
+        #. id(NUMBER)

docs/api/entities/SchoolClass.rst

@@ -0,0 +1,9 @@
+List of properties from SchoolClass
+===================================
+        #. school_day_start(NUMBER(Date representation wrapped))
+        #. school_day_end(NUMBER(Date representation wrapped))
+        #. school(OBJECT< `School <http://docs.ivis.se/en/latest/api/entities/School.html>`_ >)
+        #. pupils(ARRAY< `Pupil <http://docs.ivis.se/en/latest/api/entities/Pupil.html>`_ >)
+        #. diaries(ARRAY< `Diary <http://docs.ivis.se/en/latest/api/entities/Diary.html>`_ >)
+        #. name(STRING)
+        #. id(NUMBER)

docs/api/entities/SchoolTransport.rst

@@ -0,0 +1,4 @@
+List of properties from SchoolTransport
+=======================================
+        #. name(STRING)
+        #. id(NUMBER)

docs/api/entities/SearchCriteries$Order.rst

@@ -0,0 +1,7 @@
+List of properties from SearchCriteries$Order
+=============================================
+
+It is enum, that has STRING values.
+
+Values:
+    "ASC", "DESC".

docs/api/entities/SearchCriteries$SearchCriteriaResult.rst

@@ -0,0 +1,9 @@
+List of properties from SearchCriteries$SearchCriteriaResult
+============================================================
+        #. field_name(STRING)
+        #. operation(OBJECT< `SearchOperation <http://docs.ivis.se/en/latest/api/entities/SearchOperation.html>`_ >)
+        #. value(STRING)
+        #. value_type(STRING<ENTITY_CLASS_NAME>)
+        #. next_and(BOOLEAN)
+        #. order_by(STRING)
+        #. order(OBJECT< `SearchCriteries$Order <http://docs.ivis.se/en/latest/api/entities/SearchCriteries$Order.html>`_ >)