GET ./elevi
Tags: simple-query, pagination
It is used to return the students from a school.
elevSex options:
- 1 - male
- 2 - female
elevStatusID options:
- 1 - Default - active student
- 3 - Transferred (gone)
- 4 - Transferred (income)
- 5 - Transferred (scholarship)
- 6 - Alumni
etTransferTip options:
- 1 - income
- 2 - gone
GET parameters
Name | Value Type | Validation | Details |
---|---|---|---|
ascID | int | Required | School year ID. |
clID | int | Optional | Class ID. Return the students from the class. |
includeDeleted | int | Optional, value[0,1] | Specifies whether to include deleted students. It is used only by the administrator. |
includeTransferred | int | Optional, value[0,1] | Specifies whether to include transferred students. It is used only by the administrator. |
includeAlumni | int | Optional, value[0,1] | Specifies whether to include Alumni students. It is used only by the administrator. |
q | string | Optional, min_length[3] | Search query for elevNume and elevPrenume |
Validation
Error Field | Error Code | Error Message |
---|---|---|
ascID | 101 | Invalid ascID. |
Output example
{"meta": {"countTotal": "28","countData": "1","countOffset": "0"},"data": [{"elevID": "12473","elevNume": "Andronic","elevPrenume": "Mihai","elevInitTata": "C","elevSex": "1","elevStatusID": "1","elevAvatar": "","elevStatusID": "3","roles": [{"roleID": "13","roleName": "Elev"}],"transferInfo": {"etID": "95","etAscID": "26","etTransferTip": "1","etNrTransfer": "1000","etDataTransfer": "2022-01-04"},}]}