The system is soon moving from Single to Multiple Course Enrollment. Necessary updates in the Rest API data were made in order to synchronize with the new feature.

This article guides you on the API updates required to be implemented for successful integration to work. This document is specially meant for developers concerned with linking Classe365 data with third party suppliers.

1) Authentication

API Documentation: https://speca.io/classe365/academics#authentication_group

For authentication, we use basic HTTP authentication. So you need to pass base64 encoded string of “<tenant_name>:<api_key>” in credentials.

You can generate the API key from our Web App’s Admin Panel > Settings > APIs page.

CURL Command Example

curl … “Authorization: Basic <base64 encoded string of tenant_name:api_key” …

PHP CURL Example

$auth_token = base64_encode("<tenant_name>:<api_key>");

$headers = array(“Content-type:application/json”, "Authorization: Basic ".$auth_token );

$ch = curl_init();

curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

2) Academics

The set of APIs in this section allow you to create and update departments, classes, subjects.

API Documentation Link	Type	Endpoint URL
Insert/Update Department	POST	/rest/academic
Insert/Update Class	POST	/rest/academic
Insert/Update Section	POST	/rest/academic
Insert or Update a Subject	POST	/rest/academic
Get Data For A Particular Department, Class, Section or Subject	GET	/rest/getAcademicDataForParticular
Get Academic Structure Data For All Classes, Sections And Subjects Together	GET	/rest/getAcademicDataForAll

3) Academic Sessions

This API allows you to get the data of all unlocked academic sessions.

API Documentation: https://speca.io/classe365/academics#get-academic-sessions

Example:

curl -X GET "https://evaluate3x.classe365.com/rest/academicSessions" H -H "Content-Type: application/json" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm"

4) Teachers and Admin Staff

This group contains the API documentation related to teachers and admin staff information.

API Documentation Link	Type	Endpoint URL
Insert or Update Teachers Data	POST	/rest/teacher
Get Teacher Data	GET	/rest/teachersData
Insert/Update Admin	POST	/rest/admin
Get Admin Data	GET	/rest/adminsData

Example:

To Insert Teacher

curl -X POST "https://evaluate3x.classe365.com/rest/teacher"   -H -H "Content-Type: application/json" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm"   -d 'data={"teacher_id":"2016_1_apinew","first_name":"Cary","last_name":"Baxter","teacher_dob":"1991-05-11","teacher_email":"[email protected]","teacher_contact":"12972565652","is_academic":1,"image": "data:image/png;base64,BASE64CODE"}'

To Update Teacher

curl -X POST "https://evaluate3x.classe365.com/rest/teacher"   -H -H "Content-Type: application/json" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm"   -d 'data={"id":8,"teacher_id":"2019","first_name":"Cary","last_name":"Baxter","teacher_dob":"1992-05-11","teacher_email":"[email protected]","teacher_contact":"12972565652","is_academic":1,"image": "data:image/png;base64,BASE64CODE"}'

5) Students

This group contains the API documentation related to students insert and update actions.

The following data variables in the response data will be removed - Class/Section/Subject.
A new data variable, called "Enrollments" will be added.

API Documentation Link	Type	Endpoint URL
Add or Update Student	POST	/rest/student
Student Course Enrollment	POST	/rest/studentCourseEnroll
Student Elective Subject Enrollment	POST	/rest/electiveSubjectsAllocation
Update Student Subject Status	POST	/rest/studentSubjectStatusUpdate
Get Total Student Count	GET	/rest/getTotalStudentCount
Get Student Data	GET	/rest/studentsData
Student Status change	POST	/rest/studentStatusUpdate
Student Attributes	GET	/rest/studentAttributes

Example:

Add Student

curl -X POST "https://evaluate3x.classe365.com/rest/student"  \  -H -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm" \  -d 'data={"admission_number":"2016_1_api","first_name":"Classe","last_name":"Developer","student_dob":"2000-05-08","student_email":"[email protected]","student_contact":"123123123","gender":"Male","father_name":"Johnson","mother_name":"Scarlett","parents_contact":"11111111","parents_email":"[email protected]"}'

Update Student

curl -X POST "https://evaluate3x.classe365.com/rest/student"  \  -H -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm" \  -d 'data={"id":"19","admission_number":"2016_1_api","first_name":"Stephen","last_name":"hawking","student_dob":"2000-05-08","student_email":"[email protected]","student_contact":"123123123","gender":"Male","father_name":"Johnson","mother_name":"Scarlett","parents_contact":"11111111","parents_email":"[email protected]"}'

6) Attendance

This group lists the API documentation for attendance.

API Documentation Link	Type	Endpoint URL
Add or Update Attendance	POST	/rest/manageAttendance
Get Attendance Data	GET	/rest/attendanceData
Get Attendance Data for All Students and a Particular Date	GET	/rest/allAttendanceByDate
Get Attendance Data for All Students and Particular Date in Linear View	GET	/rest/attendanceByDateInLV
Get Attendance Settings	GET	/rest/attendanceSettings

Example

Save Attendance

curl -X POST "https://evaluate3x.classe365.com/rest/manageAttendance"  \  -H -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm" \  -d 'acds_id=1&class_id=1&section_id=1&subject_id=1&session_id=6&date=2019-11-27&working=1&attendance_data={"2":{"status":"p","comment":""},"4":{"status":"a","comment":""},"5":{"status":"a","comment":""},"6":{"status":"a","comment":""},"9":{"status":"p","comment":""},"10":{"status":"p","comment":""},"12":{"status":"p","comment":""}}'

GET Attendance Data

curl -X GET "https://evaluate3x.classe365.com/rest/attendanceData?acds_id=1&class_id=1&section_id=1&date=2019-11-08&subject_id=1&session_id=6"  -H -H "Content-Type: application/json" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm"

GET Attendance Data for All Students and a Particular Date

curl -X GET "https://evaluate3x.classe365.com/rest/allAttendanceByDate?acds_id=1&date=2019-11-07"  -H -H "Content-Type: application/json" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm"

Get Attendance Data for All Students and Particular Date in Linear View

curl -X GET "https://evaluate3x.classe365.com/rest/attendanceByDateInLV?acds_id=1&date=2020-01-13"  -H -H "Content-Type: application/json" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm"

Get Attendance Settings

curl -X GET "https://evaluate3x.classe365.com/rest/attendanceSettings?acds_id=1"  -H -H "Content-Type: application/json" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm"

7) Grading and Assessments

This section lists the API documentation for the APIs related to grading and assessments.

API Documentation Link	Type	Endpoint URL
Get Assessments Score for a Student	GET	/rest/studentScore
Get Assessments Score for Multiple Students	GET	/rest/studentsScore
Get Assessments Score for a Subject	GET	/rest/subjectScore
Add or Update Assessment Score	POST	/rest/saveAssessmentScore
Get Assessments	GET	/rest/getAssessments

Example:

Get Assessments Score for a Student

curl -X GET "https://evaluate3x.classe365.com/rest/studentScore?id=2&acds_id=1"  -H -H "Content-Type: application/json" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm"

Get Assessments Score for Multiple Students

curl -X GET "https://evaluate3x.classe365.com/rest/studentsScore?recordsPerPage=10&pageNo=2&acds_id=1"  -H -H "Content-Type: application/json" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm"

Get Assessments Score for a Subject

curl -X GET "https://evaluate3x.classe365.com/rest/subjectScore?id=1&acds_id=1"  -H -H "Content-Type: application/json" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm"

Add or Update Assessment Score

curl -X POST "https://evaluate3x.classe365.com/rest/saveAssessmentScore" -H -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm" -d 'acds_id=1&assessment_id=1&subject_id=1&score_data={"4":{"score":"20","comment":"Good","status":""},"2":{"score":"10","comment":"Poor Performance","status":""},"6":{"score":"","comment":"","status":"EXE"}}'

Get Assessments

curl -X GET "https://evaluate3x.classe365.com/rest/getAssessments?acds_id=1"  -H -H "Content-Type: application/json" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm"

8) Invoicing and Payments

This section lists the API documentation for the APIs related to invoicing and payments.

API Documentation Link	Type	Endpoint URL
Get Fees Data for all Fees, Invoices, and Payments together or for a particular Fees/Invoice/Payment	GET	/rest/feesInfo
Get Invoices Data	GET	/rest/feeInvoicesData
Create Invoices	POST	/rest/createInvoice
Create or Update Payments	POST	/rest/createUpdatePayment

Example

Get data for particular fees category using fee_id.

curl -X POST "https://demo.classe365.com/rest/feesInfo?fee_id=1&format=json"  -H -H "Content-Type: application/json" -H "Authorization: Basic ZGVtbzorQENlOUx6Unl3YjVtNXE2"

Get data for particular invoice using invoice_id.

curl -X POST "https://demo.classe365.com/rest/feesInfo?invoice_id=1&format=json"  -H -H "Content-Type: application/json" -H "Authorization: Basic ZGVtbzorQENlOUx6Unl3YjVtNXE2"

Get data for particular payment using payment_id.

curl -X POST "https://demo.classe365.com/rest/feesInfo?payment_id=1&format=json"  -H -H "Content-Type: application/json" -H "Authorization: Basic ZGVtbzorQENlOUx6Unl3YjVtNXE2"

Get data for all fees category.

curl -X POST "https://demo.classe365.com/rest/feesInfo?format=json"  -H -H "Content-Type: application/json" -H "Authorization: Basic ZGVtbzorQENlOUx6Unl3YjVtNXE2"

9) Finance & Accounting

This API allows you to get ledger accounts data.

API Documentation Link	Type	Endpoint URL
Get Ledger Accounts Data	GET	/rest/ledgerAccounts
Get Account Entries Data	GET	/rest/accountEntries

Example:

Get Ledger Accounts Data

curl -X GET "https://demo.classe365.com/rest/accountEntries?account_id=fy2021&page=1&from_date=2023-04-01&to_date=2023-04-30" \
-H -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic ZGVtbzorQENlOUx6Unl3YjVtNXE2"

Get Account Entries Data

curl -X GET "https://demo.classe365.com/rest/accountEntries?account_id=fy2021&page=1&from_date=2023-04-01&to_date=2023-04-30" \
-H -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic ZGVtbzorQENlOUx6Unl3YjVtNXE2"

10) CRM-Enroll & Forms

This API allows you to add a submission, retrieve form details and retrieve the submissions data or update existing submission details.

API Documentation Link	Type	Endpoint URL
Add or Update Form Submission Details	POST	/rest/formSubmit
Get Form Submission Details	GET	/rest/getSubmission
Get Submissions Data	GET	/rest/getSubmissionsData

Example

Get Submissions Data

curl -X GET "https://demo.classe365.com/rest/getSubmissionsData?page={"recordsPerPage":"10","pageNo":"1"}" \
-H -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic ZGVtbzorQENlOUx6Unl3YjVtNXE2"

Get Particular Submisssion

curl -X GET "https://demo.classe365.com/rest/getSubmissionsData?filter={"id":"4"}" \
-H -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic ZGVtbzorQENlOUx6Unl3YjVtNXE2"

11) Agents

This API allows you to add agent data or update existing agent data.

API Documentation Link	Type	Endpoint URL
Add or Update Agent Data	POST	/rest/agent
Get Agents Data	GET	/rest/agentsData

Example

Get Agents Data

curl -X GET "https://evaluate3x.classe365.com/rest/agentsData?age={"recordsPerPage":"10","pageNo":"1"}" \ -H -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm"

Get Particular Agent

curl -X GET "https://evaluate3x.classe365.com/rest/agentsData?filter={"id":"4"}" \
-H -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm"

12) Tasks

This API allows you to add, and retrieve task data.

API Documentation Link	Type	Endpoint URL
Add Task Data	POST	/rest/saveTaskData
Get Tasks Data	GET	/rest/tasksData

Example

Add Task Data

curl -X POST "https://evaluate3x.classe365.com/rest/saveTaskData"  \
 -H -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic ZXZhbHVhdGUzeDpsY2g4Y0QqeFJqMzMwVmEm" \
 -d 'data={"title":"Exam for monthly assessment", "description":"Description for task", "category_id":"Exam", "type":"todo", "start_date":"2024-07-01", "start_time":"12:00:00", "end_date":"2024-07-31", "end_time":"11:59:59", "status":"Pending", "priority":"high", "students":"2021_123,2021_163", "created_by":"3" }'

For more information or clarifications, just reach us at [email protected]

Classe365 API Introduction

Google Workspace Integration with Classe365

Getting Started with the Classe365 REST API v2

Rest API update : Phase 1

1) Authentication

2) Academics

3) Academic Sessions

Example:

4) Teachers and Admin Staff

Example:

To Insert Teacher

5) Students

Example:

Add Student

Update Student

6) Attendance

Example

Save Attendance

GET Attendance Data

GET Attendance Data for All Students and a Particular Date

Get Attendance Data for All Students and Particular Date in Linear View

Get Attendance Settings

7) Grading and Assessments

Example:

Get Assessments Score for a Student

Get Assessments Score for Multiple Students

Get Assessments Score for a Subject

Add or Update Assessment Score

Get Assessments

8) Invoicing and Payments

Example

Get data for particular fees category using fee_id.

Get data for particular invoice using invoice_id.

Get data for particular payment using payment_id.

Get data for all fees category.

9) Finance & Accounting

Example:

Get Ledger Accounts Data

Get Account Entries Data

10) CRM-Enroll & Forms

Example

Get Submissions Data

Get Particular Submisssion

11) Agents

Example

Get Agents Data

Get Particular Agent

12) Tasks

Example

Add Task Data