Students

SmartClass Students API in order to get, insert, update and delete students

get
Get Students

https://schoolid.smartclass.school/public/v1/students
This endpoint allows you to get all students.
Request
Response
Headers
Authorization
required
string
Authorization Token
schoolId
required
string
School Id of the Authorization Token
200: OK
Returns students and number of students as json
{
"students": [
{
"stdId": 69,
"studentId": "8723872",
"studentNumber": 81,
"name": "Mehmet",
"secondName": "Onur",
"lastname": "Fıraty",
"gender": "Male",
"nationality": null,
"dob": "04.01.2006",
"pob": "istanbul",
"studentCellPhone": "2342333",
"studentEmail": "mehmet.fırat@smartclass.biz",
"fatherName": "Rıfatt",
"fatherCellPhone": "29834982",
"fatherEmail": "fırat.rıfat@smartclass",
"motherName": "Rezann",
"motherCellPhone": "232322",
"motherEmail": "rezan@smartclass.biz",
"schoolId": 2,
"schoolTitle": "Özel Demo Ortaokulu",
"courseId": 28,
"courseTitle": "7.Sınıflar",
"batchId": 24,
"batchTitle": "7-A",
"parents": [
{
"parentId": "1114234324",
"parentName": "Rıfatt",
"parentType": "Baba",
"parentCellPhone": "29834982",
"parentEmail": "fırat.rıfat@smartclass"
},
{
"parentId": "5115122",
"parentName": "Rezann",
"parentType": "Anne",
"parentCellPhone": "232322",
"parentEmail": "rezan@smartclass.biz"
}
]
}
],
"nofStudents": 1
}

get
Get A Student

https://schoolid.smartclass.school/public/v1/students/:id
This endpoint allows you to get a specific student.
Request
Response
Path Parameters
id
required
string
student id that could be unique SmartClass student id or SSN (for US) or citizen id number
Headers
Authorization
required
string
Authorization Token
schoolId
required
string
School Id of the Authorization Token
200: OK
Returns the student if found.
{
"students": [
{
"stdId": 69,
"studentId": "8723872",
"studentNumber": 81,
"name": "Mehmet",
"secondName": "Onur",
"lastname": "Fıraty",
"gender": "Male",
"nationality": null,
"dob": "04.01.2006",
"pob": "istanbul",
"studentCellPhone": "2342333",
"studentEmail": "mehmet.fırat@smartclass.biz",
"fatherName": "Rıfatt",
"fatherCellPhone": "29834982",
"fatherEmail": "fırat.rıfat@smartclass",
"motherName": "Rezann",
"motherCellPhone": "232322",
"motherEmail": "rezan@smartclass.biz",
"schoolId": 2,
"schoolTitle": "Özel Demo Ortaokulu",
"courseId": 28,
"courseTitle": "7.Sınıflar",
"batchId": 24,
"batchTitle": "7-A",
"parents": [
{
"parentId": "1114234324",
"parentName": "Rıfatt",
"parentType": "Baba",
"parentCellPhone": "29834982",
"parentEmail": "fırat.rıfat@smartclass"
},
{
"parentId": "5115122",
"parentName": "Rezann",
"parentType": "Anne",
"parentCellPhone": "232322",
"parentEmail": "rezan@smartclass.biz"
}
]
}
],
"nofStudents": 1
}

post
Add Student

https://schoolid.smartclass.school/public/v1/students
This endpoint allows you to add a student.
Request
Response
Headers
Authorization
required
string
Authorization Token
schoolId
required
string
School Id of the Authorization Token
Body Parameters
studentNumber
optional
integer
school number of the student
studentId
required
string
student id that is SSN (for US) or unique citizen id number
name
required
string
first name of the student
secondName
optional
string
middle name of the student
lastname
required
string
lastname of the student
gender
required
string
E for male, K for female and any other if available for the instance
nationality
optional
string
nationality of the student
dob
optional
string
date of birth in the format of YYYY-MM-DD
pob
optional
string
birth place
studentCellPhone
optional
string
mobile phone number of the student
studentEmail
optional
string
email address of the student
fatherName
optional
string
father's name and lastname of the student
fatherCellPhone
optional
string
father's mobile phone number
fatherEmail
optional
string
father's email address
motherName
optional
string
mother's name and lastname of the student
motherCellPhone
optional
string
mother's mobile phone number
motherEmail
optional
string
mother's email address
parentId
required
string
parent id that is parent's SSN (for US) or unique citizen id number is required to create the parent of the student. If it is not provided, parent information will not be created.
parentName
optional
string
parent's name and lastname
parentCellPhone
optional
string
parent's mobile phone number
parentEmail
optional
string
parent's email address
200: OK

put
Update Student

https://schoolid.smartclass.school/public/v1/students/:id
This endpoint allows you to update a student. You can use the same body parameters as adding a student.
Request
Response
Headers
Authorization
required
string
Authorization Token
schoolId
required
string
School Id of the Authorization Token
200: OK