Schools¶
(implementation of School entity)
Provides following method for API calls:
Create¶
URL:¶
/api/v1/{format}/school
Method:¶
POST
Parameters response:¶
Object
Description:
- school_id(STRING)
- services(ARRAY< ServiceTypeEnum >)
- school_classes(ARRAY< SchoolClass >)
- after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
- name(STRING)
- id(NUMBER)
Delete¶
URL:¶
/api/v1/{format}/school/{id}
Method:¶
DELETE
Parameters request:¶
null
Parameters response:¶
Object
Description:
- school_id(STRING)
- services(ARRAY< ServiceTypeEnum >)
- school_classes(ARRAY< SchoolClass >)
- after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
- name(STRING)
- id(NUMBER)
DeleteByIds¶
URL:¶
/api/v1/{format}/schools
Method:¶
DELETE
Parameters request:¶
Url parameters: ids
Parameters response:¶
Array
Description:
- school_id(STRING)
- services(ARRAY< ServiceTypeEnum >)
- school_classes(ARRAY< SchoolClass >)
- after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
- name(STRING)
- id(NUMBER)
Get¶
URL:¶
/api/v1/{format}/school/{id}
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Object
Description:
- school_id(STRING)
- services(ARRAY< ServiceTypeEnum >)
- school_classes(ARRAY< SchoolClass >)
- after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
- name(STRING)
- id(NUMBER)
GetAll¶
URL:¶
/api/v1/{format}/schools
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Array
Description:
- school_id(STRING)
- services(ARRAY< ServiceTypeEnum >)
- school_classes(ARRAY< SchoolClass >)
- after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
- name(STRING)
- id(NUMBER)
GetByName¶
URL:¶
/api/v1/{format}/schools
Method:¶
GET
Parameters request:¶
Url parameters: name
Parameters response:¶
Array
Description:
- school_id(STRING)
- services(ARRAY< ServiceTypeEnum >)
- school_classes(ARRAY< SchoolClass >)
- after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
- name(STRING)
- id(NUMBER)
GetFirstByName¶
URL:¶
/api/v1/{format}/school
Method:¶
GET
Parameters request:¶
Url parameters: name, first
Parameters response:¶
Object
Description:
- school_id(STRING)
- services(ARRAY< ServiceTypeEnum >)
- school_classes(ARRAY< SchoolClass >)
- after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
- name(STRING)
- id(NUMBER)
GetPersonsBySchool¶
URL:¶
/api/v1/{format}/school/{id}/persons
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Array
Description:
- personal_id(STRING)
- first_name(STRING)
- last_name(STRING)
- addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
- emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
- phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
- id(NUMBER)
SaveAll¶
URL:¶
/api/v1/{format}/schools/saveall
Method:¶
POST
Parameters response:¶
Array
Description:
- school_id(STRING)
- services(ARRAY< ServiceTypeEnum >)
- school_classes(ARRAY< SchoolClass >)
- after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
- name(STRING)
- id(NUMBER)
SaveAllAndReturnIds¶
URL:¶
/api/v1/{format}/schools/saveall
Method:¶
POST
Parameters response:¶
Array
- Description:
- ARRAY<NUMBER>
Search¶
URL:¶
/api/v1/{format}/schools/search
Method:¶
POST
Parameters request:¶
Array< SearchCriteries$SearchCriteriaResult >
Parameters response:¶
Array
Description:
- school_id(STRING)
- services(ARRAY< ServiceTypeEnum >)
- school_classes(ARRAY< SchoolClass >)
- after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
- name(STRING)
- id(NUMBER)
SearchFirst¶
URL:¶
/api/v1/{format}/school/search
Method:¶
POST
Parameters request:¶
Array< SearchCriteries$SearchCriteriaResult >
Parameters response:¶
Object
Description:
- school_id(STRING)
- services(ARRAY< ServiceTypeEnum >)
- school_classes(ARRAY< SchoolClass >)
- after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
- name(STRING)
- id(NUMBER)
Update¶
URL:¶
/api/v1/{format}/school/{id}
Method:¶
PUT
Parameters request:¶
null
Parameters response:¶
Object
Description:
- school_id(STRING)
- services(ARRAY< ServiceTypeEnum >)
- school_classes(ARRAY< SchoolClass >)
- after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
- name(STRING)
- id(NUMBER)