Pupils

(implementation of Pupil entity)

Provides following method for API calls:

• Create
• Delete
• DeleteByIds
• Get
• GetAll
• GetAllPupils
• GetByPersonalId
• GetFirstByPersonalId
• SaveAll
• SaveAllAndReturnIds
• Search
• SearchFirst
• Update

Create

URL:

/api/v1/{format}/pupils

Method:

POST

Parameters request:

Object< Pupil >

Parameters response:

Object

Description:

1. person(OBJECT< Person >)
2. contact_person(OBJECT< Person >)
3. class_placement_from(NUMBER(Date representation wrapped))
4. class_placement_to(NUMBER(Date representation wrapped))
5. school_class(OBJECT< SchoolClass >)
6. school(OBJECT< School >)
7. academic_year(OBJECT< AcademicYear >)
8. guardians(ARRAY< Guardian >)
9. truancies(ARRAY< Truancy >)
10. after_school_center_section(OBJECT< AfterSchoolCenterSection >)
11. school_center_schema(ARRAY< AfterSchoolCenterSchema >)
12. id(NUMBER)

Delete

URL:

/api/v1/{format}/pupils/{id}

Method:

DELETE

Parameters request:

null

Parameters response:

Object

Description:

1. person(OBJECT< Person >)
2. contact_person(OBJECT< Person >)
3. class_placement_from(NUMBER(Date representation wrapped))
4. class_placement_to(NUMBER(Date representation wrapped))
5. school_class(OBJECT< SchoolClass >)
6. school(OBJECT< School >)
7. academic_year(OBJECT< AcademicYear >)
8. guardians(ARRAY< Guardian >)
9. truancies(ARRAY< Truancy >)
10. after_school_center_section(OBJECT< AfterSchoolCenterSection >)
11. school_center_schema(ARRAY< AfterSchoolCenterSchema >)
12. id(NUMBER)

DeleteByIds

URL:

/api/v1/{format}/pupils

Method:

DELETE

Parameters request:

Url parameters: ids

Parameters response:

Array

Description:

1. person(OBJECT< Person >)
2. contact_person(OBJECT< Person >)
3. class_placement_from(NUMBER(Date representation wrapped))
4. class_placement_to(NUMBER(Date representation wrapped))
5. school_class(OBJECT< SchoolClass >)
6. school(OBJECT< School >)
7. academic_year(OBJECT< AcademicYear >)
8. guardians(ARRAY< Guardian >)
9. truancies(ARRAY< Truancy >)
10. after_school_center_section(OBJECT< AfterSchoolCenterSection >)
11. school_center_schema(ARRAY< AfterSchoolCenterSchema >)
12. id(NUMBER)

Get

URL:

/api/v1/{format}/pupils/{id}

Method:

GET

Parameters request:

null

Parameters response:

Object

Description:

1. person(OBJECT< Person >)
2. contact_person(OBJECT< Person >)
3. class_placement_from(NUMBER(Date representation wrapped))
4. class_placement_to(NUMBER(Date representation wrapped))
5. school_class(OBJECT< SchoolClass >)
6. school(OBJECT< School >)
7. academic_year(OBJECT< AcademicYear >)
8. guardians(ARRAY< Guardian >)
9. truancies(ARRAY< Truancy >)
10. after_school_center_section(OBJECT< AfterSchoolCenterSection >)
11. school_center_schema(ARRAY< AfterSchoolCenterSchema >)
12. id(NUMBER)

GetAll

URL:

/api/v1/{format}/pupils

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

1. person(OBJECT< Person >)
2. contact_person(OBJECT< Person >)
3. class_placement_from(NUMBER(Date representation wrapped))
4. class_placement_to(NUMBER(Date representation wrapped))
5. school_class(OBJECT< SchoolClass >)
6. school(OBJECT< School >)
7. academic_year(OBJECT< AcademicYear >)
8. guardians(ARRAY< Guardian >)
9. truancies(ARRAY< Truancy >)
10. after_school_center_section(OBJECT< AfterSchoolCenterSection >)
11. school_center_schema(ARRAY< AfterSchoolCenterSchema >)
12. id(NUMBER)

GetAllPupils

URL:

/api/v1/{format}/pupils/all

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

1. person(OBJECT< Person >)
2. contact_person(OBJECT< Person >)
3. class_placement_from(NUMBER(Date representation wrapped))
4. class_placement_to(NUMBER(Date representation wrapped))
5. school_class(OBJECT< SchoolClass >)
6. school(OBJECT< School >)
7. academic_year(OBJECT< AcademicYear >)
8. guardians(ARRAY< Guardian >)
9. truancies(ARRAY< Truancy >)
10. after_school_center_section(OBJECT< AfterSchoolCenterSection >)
11. school_center_schema(ARRAY< AfterSchoolCenterSchema >)
12. id(NUMBER)

GetByPersonalId

URL:

/api/v1/{format}/pupils

Method:

GET

Parameters request:

Url parameters: personalId

Parameters response:

Array

Description:

1. person(OBJECT< Person >)
2. contact_person(OBJECT< Person >)
3. class_placement_from(NUMBER(Date representation wrapped))
4. class_placement_to(NUMBER(Date representation wrapped))
5. school_class(OBJECT< SchoolClass >)
6. school(OBJECT< School >)
7. academic_year(OBJECT< AcademicYear >)
8. guardians(ARRAY< Guardian >)
9. truancies(ARRAY< Truancy >)
10. after_school_center_section(OBJECT< AfterSchoolCenterSection >)
11. school_center_schema(ARRAY< AfterSchoolCenterSchema >)
12. id(NUMBER)

GetFirstByPersonalId

URL:

/api/v1/{format}/pupils

Method:

GET

Parameters request:

Url parameters: personalId, first

Parameters response:

Object

Description:

1. person(OBJECT< Person >)
2. contact_person(OBJECT< Person >)
3. class_placement_from(NUMBER(Date representation wrapped))
4. class_placement_to(NUMBER(Date representation wrapped))
5. school_class(OBJECT< SchoolClass >)
6. school(OBJECT< School >)
7. academic_year(OBJECT< AcademicYear >)
8. guardians(ARRAY< Guardian >)
9. truancies(ARRAY< Truancy >)
10. after_school_center_section(OBJECT< AfterSchoolCenterSection >)
11. school_center_schema(ARRAY< AfterSchoolCenterSchema >)
12. id(NUMBER)

SaveAll

URL:

/api/v1/{format}/pupils/saveall

Method:

POST

Parameters request:

Array< Pupil >

Parameters response:

Array

Description:

1. person(OBJECT< Person >)
2. contact_person(OBJECT< Person >)
3. class_placement_from(NUMBER(Date representation wrapped))
4. class_placement_to(NUMBER(Date representation wrapped))
5. school_class(OBJECT< SchoolClass >)
6. school(OBJECT< School >)
7. academic_year(OBJECT< AcademicYear >)
8. guardians(ARRAY< Guardian >)
9. truancies(ARRAY< Truancy >)
10. after_school_center_section(OBJECT< AfterSchoolCenterSection >)
11. school_center_schema(ARRAY< AfterSchoolCenterSchema >)
12. id(NUMBER)

SaveAllAndReturnIds

URL:

/api/v1/{format}/pupils/saveall

Method:

POST

Parameters request:

Url parameters: full

Array< Pupil >

Parameters response:

Array

Description:

ARRAY<NUMBER>

Search

URL:

/api/v1/{format}/pupils/search

Method:

POST

Parameters request:

Array< SearchCriteries$SearchCriteriaResult >

Parameters response:

Array

Description:

1. person(OBJECT< Person >)
2. contact_person(OBJECT< Person >)
3. class_placement_from(NUMBER(Date representation wrapped))
4. class_placement_to(NUMBER(Date representation wrapped))
5. school_class(OBJECT< SchoolClass >)
6. school(OBJECT< School >)
7. academic_year(OBJECT< AcademicYear >)
8. guardians(ARRAY< Guardian >)
9. truancies(ARRAY< Truancy >)
10. after_school_center_section(OBJECT< AfterSchoolCenterSection >)
11. school_center_schema(ARRAY< AfterSchoolCenterSchema >)
12. id(NUMBER)

SearchFirst

URL:

/api/v1/{format}/pupils/search/first

Method:

POST

Parameters request:

Array< SearchCriteries$SearchCriteriaResult >

Parameters response:

Object

Description:

1. person(OBJECT< Person >)
2. contact_person(OBJECT< Person >)
3. class_placement_from(NUMBER(Date representation wrapped))
4. class_placement_to(NUMBER(Date representation wrapped))
5. school_class(OBJECT< SchoolClass >)
6. school(OBJECT< School >)
7. academic_year(OBJECT< AcademicYear >)
8. guardians(ARRAY< Guardian >)
9. truancies(ARRAY< Truancy >)
10. after_school_center_section(OBJECT< AfterSchoolCenterSection >)
11. school_center_schema(ARRAY< AfterSchoolCenterSchema >)
12. id(NUMBER)

Update

URL:

/api/v1/{format}/pupils/{id}

Method:

PUT

Parameters request:

Object< Pupil >

Parameters response:

Object

Description:

1. person(OBJECT< Person >)
2. contact_person(OBJECT< Person >)
3. class_placement_from(NUMBER(Date representation wrapped))
4. class_placement_to(NUMBER(Date representation wrapped))
5. school_class(OBJECT< SchoolClass >)
6. school(OBJECT< School >)
7. academic_year(OBJECT< AcademicYear >)
8. guardians(ARRAY< Guardian >)
9. truancies(ARRAY< Truancy >)
10. after_school_center_section(OBJECT< AfterSchoolCenterSection >)
11. school_center_schema(ARRAY< AfterSchoolCenterSchema >)
12. id(NUMBER)