SchoolClasses

(implementation of SchoolClass entity)

Provides following method for API calls:

• Create
• Delete
• DeleteByIds
• Get
• GetAll
• GetByName
• GetFirstByName
• SaveAll
• SaveAllAndReturnIds
• Search
• SearchFirst
• Update

Create

URL:

/api/v1/{format}/schoolclasses

Method:

POST

Parameters request:

Object< SchoolClass >

Parameters response:

Object

Description:

1. school_day_start(NUMBER(Date representation wrapped))
2. school_day_end(NUMBER(Date representation wrapped))
3. school(OBJECT< School >)
4. pupils(ARRAY< Pupil >)
5. diaries(ARRAY< Diary >)
6. name(STRING)
7. id(NUMBER)

Delete

URL:

/api/v1/{format}/schoolclasses/{id}

Method:

DELETE

Parameters request:

null

Parameters response:

Object

Description:

1. school_day_start(NUMBER(Date representation wrapped))
2. school_day_end(NUMBER(Date representation wrapped))
3. school(OBJECT< School >)
4. pupils(ARRAY< Pupil >)
5. diaries(ARRAY< Diary >)
6. name(STRING)
7. id(NUMBER)

DeleteByIds

URL:

/api/v1/{format}/schoolclasses

Method:

DELETE

Parameters request:

Url parameters: ids

Parameters response:

Array

Description:

1. school_day_start(NUMBER(Date representation wrapped))
2. school_day_end(NUMBER(Date representation wrapped))
3. school(OBJECT< School >)
4. pupils(ARRAY< Pupil >)
5. diaries(ARRAY< Diary >)
6. name(STRING)
7. id(NUMBER)

Get

URL:

/api/v1/{format}/schoolclasses/{id}

Method:

GET

Parameters request:

null

Parameters response:

Object

Description:

1. school_day_start(NUMBER(Date representation wrapped))
2. school_day_end(NUMBER(Date representation wrapped))
3. school(OBJECT< School >)
4. pupils(ARRAY< Pupil >)
5. diaries(ARRAY< Diary >)
6. name(STRING)
7. id(NUMBER)

GetAll

URL:

/api/v1/{format}/schoolclasses

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

1. school_day_start(NUMBER(Date representation wrapped))
2. school_day_end(NUMBER(Date representation wrapped))
3. school(OBJECT< School >)
4. pupils(ARRAY< Pupil >)
5. diaries(ARRAY< Diary >)
6. name(STRING)
7. id(NUMBER)

GetByName

URL:

/api/v1/{format}/schoolclasses

Method:

GET

Parameters request:

Url parameters: name

Parameters response:

Array

Description:

1. school_day_start(NUMBER(Date representation wrapped))
2. school_day_end(NUMBER(Date representation wrapped))
3. school(OBJECT< School >)
4. pupils(ARRAY< Pupil >)
5. diaries(ARRAY< Diary >)
6. name(STRING)
7. id(NUMBER)

GetFirstByName

URL:

/api/v1/{format}/schoolclasses

Method:

GET

Parameters request:

Url parameters: name, first

Parameters response:

Object

Description:

1. school_day_start(NUMBER(Date representation wrapped))
2. school_day_end(NUMBER(Date representation wrapped))
3. school(OBJECT< School >)
4. pupils(ARRAY< Pupil >)
5. diaries(ARRAY< Diary >)
6. name(STRING)
7. id(NUMBER)

SaveAll

URL:

/api/v1/{format}/schoolclasses/saveall

Method:

POST

Parameters request:

Array< SchoolClass >

Parameters response:

Array

Description:

1. school_day_start(NUMBER(Date representation wrapped))
2. school_day_end(NUMBER(Date representation wrapped))
3. school(OBJECT< School >)
4. pupils(ARRAY< Pupil >)
5. diaries(ARRAY< Diary >)
6. name(STRING)
7. id(NUMBER)

SaveAllAndReturnIds

URL:

/api/v1/{format}/schoolclasses/saveall

Method:

POST

Parameters request:

Url parameters: full

Array< SchoolClass >

Parameters response:

Array

Description:

ARRAY<NUMBER>

Search

URL:

/api/v1/{format}/schoolclasses/search

Method:

POST

Parameters request:

Array< SearchCriteries$SearchCriteriaResult >

Parameters response:

Array

Description:

1. school_day_start(NUMBER(Date representation wrapped))
2. school_day_end(NUMBER(Date representation wrapped))
3. school(OBJECT< School >)
4. pupils(ARRAY< Pupil >)
5. diaries(ARRAY< Diary >)
6. name(STRING)
7. id(NUMBER)

SearchFirst

URL:

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

Method:

POST

Parameters request:

Array< SearchCriteries$SearchCriteriaResult >

Parameters response:

Object

Description:

1. school_day_start(NUMBER(Date representation wrapped))
2. school_day_end(NUMBER(Date representation wrapped))
3. school(OBJECT< School >)
4. pupils(ARRAY< Pupil >)
5. diaries(ARRAY< Diary >)
6. name(STRING)
7. id(NUMBER)

Update

URL:

/api/v1/{format}/schoolclasses/{id}

Method:

PUT

Parameters request:

Object< SchoolClass >

Parameters response:

Object

Description:

1. school_day_start(NUMBER(Date representation wrapped))
2. school_day_end(NUMBER(Date representation wrapped))
3. school(OBJECT< School >)
4. pupils(ARRAY< Pupil >)
5. diaries(ARRAY< Diary >)
6. name(STRING)
7. id(NUMBER)