API Documentation
This API allows you to get the structure of all classes, their sections and the subjects allocated to each of the class and section.
URL : https://{subdomainName}.classe365.com/rest/getAcademicDataForAll
Method: GET
Parameters: None
Response Body
This section lists the success and failure responses of the API. The API response contains the success status (one or zero). If data is found, the response contains the data. If there is an error, the response gives details about the error. Responses are JSON encoded strings.
Case 1: Data Retrieved Successfully
See Example 1. The table below gives the description of the responses and data, when the API retrieves data successfully.
| Response Parameter | Value |
|---|---|
| success | 1 |
| Data | |
| class_id | ID of the class. |
| class_name | Name of the class. |
| class_code | Code assigned to the class. |
| department_name | Name of the department to which this class belongs to. |
| total | Total students allocated for the class. |
| actual | Total students enrolled into the class. |
| left | Number of students who quit. |
| section_id | ID of the Section. |
| section_name | Name of the section. |
| section_code | Code assigned to the section. |
| department_name | Name of the department to which this section belongs to. |
| subject_id | ID of the subject. |
| subject_name | Name of the subject. |
Case 2: Data Not found
See Example 2. The table below gives the description of the responses that appears when data is not found.
| Response Parameter | Value |
|---|---|
| success | 0 |
| error | no_record_found |
Case 1
{
"success": 1,
"data": [
{
"class_id": 1,
"class_name": class 1,
"class_code": class code,
"department_name": department 1,
"total": 20
"actual": 10,
"left": 10,
"section": [
{
"section_id": 1,
"section_name": section 1,
"section_code": section code,
"total": 10
"actual": 10,
"left": 0,
"subject": [
{
"subject_id": 1,
"subject_name": subject 1,
"subject_code": subject code,
"subject_credit": credit,
"type": Core,
},
{
"subject_id": 2,
"subject_name": subject 2,
"subject_code": subject code,
"subject_credit": credit,
"type": Elective,
"total": 10
"actual": 10,
"left": 0,
}
]
},
{
"section_id": 2,
"section_name": section 2,
"section_code": section code,
"total": null
"actual": 10,
"left": null,
"subject": []
}
]
},
{
"class_id": 2,
"class_name": class 2,
"class_code": class code,
"total": null
"actual": 10,
"left": null,
"section": []
}
]
Case 2
{
"success": 0,
"error": "no_record_found",
}
This API lists the structure and data for a particular class, section, and subjects. The results depend on the parameters you specify.
URL: https://{subdomainName}.classe365.com/rest/getAcademicDataForParticular
Method: GET
Parameters
| Parameter | Values | Description |
|---|---|---|
| Type | Can be any one of the following: Class, Section or Subject | Specifies whether the data must be retrieved for a class, section or a particular subject within a class or section |
| ID | Can be any one of the following: Class ID, Section ID, or Subject ID | Specifies the ID of the class, section or a particular subject within a class or section |
Response Body
Case 1: Data Retrieved Successfully
See Example 1. This examples shows the API output when data is retrieved successfully. This table lists the description of the results that appear when data is retrieved successfully.
| Response Parameter | Value |
|---|---|
| success | 1 |
| Data | |
| class_id | ID of the class. |
| class_name | Name of the class. |
| class_code | Code assigned to the class. |
| department_name | Name of the department to which this class belongs to. |
| total | Total students allocated for the class. |
| actual | Total students enrolled into the class. |
| left | Total students who have left the class. |
| section_id | ID of the Section. |
| section_name | Name of the section. |
| section_code | Code assigned to the section. |
| department_name | Name of the department to which this section belongs to. |
| subject_id | ID of the subject. |
| subject_name | Name of the subject. |
Case 2: Invalid Parameters
See Example 2. This example shows the API output when the parameters are invalid. This table lists the description of the results that appear when parameters are invalid.
| Response Parameter | Value |
|---|---|
| success | 0 |
| error | invalid_parameters |
Case 3: Record not found
| Response Parameter | Value |
|---|---|
| success | 0 |
| error | no_record_found |
Case 1: Data retrieved successfully
{
"success": 1,
"data": [
{
"class_id": 1,
"class_name": class 1,
"class_code": class code,
"department_name": department 1,
"total": 20
"actual": 10,
"left": 10,
}
]
}
{
"success": 1,
"data": [
{
"section_id": 1,
"section_name": section 1,
"section_code": section code,
"department_name": department 1,
"class_name": class 1,
"total": null
"actual": 10,
"left": null,
}
]
}
{
"success": 1,
"data": [
{
"subject_id": 1,
"subject_name": subject 1,
"department_name": department 1,
"class_name": class 1,
"section_name": section 1,
"subject_code": subject code,
"subject_credit": credit,
"type": Elective,
"total": 20
"actual": 20,
"left": 0,
}
]
}
{
"success": 1,
"data": [
{
"subject_id": 2,
"subject_name": subject 2,
"department_name": department 1,
"class_name": class 1,
"section_name": section 1,
"subject_code": subject code,
"subject_credit": credit,
"type": Core,
}
]
}Case 2: Invalid parameters
{
"success": 0,
"error": "invalid_parameters",
}Case 3: Record not found
{
"success": 0,
"error": "no_record_found",
}This API allows you to add or update a class, section or subjects.
URL: https://demo.classe365.com/rest/academic
Method: POST
Parameters
| Parameter | Values | Description |
|---|---|---|
| department | ||
| name | <value> | Name of the department to be created. |
| type | “department” | Static string |
| class | ||
| id | For Insert: Not Applicable | - |
| For Update: <value> for Update action | ID of the record to be updated. | |
| department_id | For Insert: <value>. This is required only if department is enabled. | ID of the department to be created |
| For Update: <value> | ID of the department to be updated. | |
| name | <value> | Name of the class to be created. |
| code | <value> | Code to be assigned to the class |
| student_limit (Optional) | <numeric positive integer value> | Max number of students in a class |
| type | “class” | Type of the object being created, here it is “class”. |
| section | ||
| id | For Insert: Not Applicable | - |
| For Update: <value> for Update action | ID of the record to be updated. | |
| class_id | For Insert: <value>. | ID of the section to be created |
| For Update: Not Applicable | - | |
| name | <value> | Name of the section to be created. |
| code | <value> | Code to be assigned to the section |
| student_limit (Optional) | <value> | Max number of students in a section |
| type | “section” | Type of the object being created, here it is “section”. |
| subject | ||
| id | For Insert: Not Applicable | - |
| For Update: <value> for Update action | ID of the record to be updated. | |
| section_id | For Insert: <value>. | ID of the section for which this subject is being assigned |
| For Update: Not Applicable | - | |
| name | <value> | Name of the subject to be created. |
| code | <value> | Code to be assigned to the subject |
| credit | <value> | Number of credit hours for this subject |
| is_elective | For Insert: Values can be: | Specify the type of elective. |
| c - Core Subject | ||
| e - Elective Subject. | ||
| For Update: Not Applicable. | - | |
| student_limit (Optional) | <value> | Max number of students for this subject. |
| type | “section” | Type of the object being created, here it is “subject”. |
Examples
Add Academic Record
[[data] => {“name”:“Class 1”,“code”:“C1”,“student_limit”:10,“type”:“class”}]
Update Academic Record
[[data] => {“id”:2,“name”:“Class 1”,“code”:“C1”,“student_limit”:10,“type”:“class”}]
Response Body
This section lists the success and failure responses of the API. Response will contain the success status of One or Zero). If a record is added or updated successfully or the request is processed successfully, then the response returns a success status of One. If it fails, the response returns a success status of Zero followed by an error condition, with details about the error.
See the different scenarios in the Examples panel on the right.
Case 1: Academic record added/updated successfully
| Response Parameter | Value |
|---|---|
| success | 1 |
Case 2: Invalid Parameters
| Response Parameter | Value |
|---|---|
| success | 0 |
| error | invalid_parameters |
Case 3: Record exists with same name
| Response Parameter | Value |
|---|---|
| success | 0 |
| error | already_exists |
Case 4: Error! While save record
| Response Parameter | Value |
|---|---|
| success | 0 |
| error | record_save_error |
Case 1: Academic record added/updated successfully
{
"success": 1
}Case 2: Invalid parameters
"success": 0,
"error": "invalid_parameters",
}Case 3: Record exists with same name
"success": 0,
"error": "already_exists"
}Case 4: Error! While save record
"success": 0,
"error": "record_save_error"
}URL: https://demo.classe365.com/rest/studentsData
Method: GET/POST
Parameters:
- filter
- json encoded string of Student fields/attributes and related values, for the fields we want to filter by
- for class and section, we need to pass class_id and section_id values
- All date values should be passed in Y-m-d format and with range structure for e.g. value for 1st Dec 2018 - “2018-12-01 to 2014-12-01” and value for 1st Dec 2018 to 10th Dec 2018 = “2018-12-01 to 2018-12-10”
- e.g: [filter] => {“id”:"",“class_id”:"",“section_id”:"",“subject_id”:"",“first_name”:"",“last_name”:"",“student_dob”:"",“student_email”:"",“gender”:"",“student_contact”:"",“parents_contact”:""}
- order
- pass field name and order type(ASC/DESC)
- e.g: [order] => [{“sortField”:“first_name”,“sortType”:“DESC”},{“sortField”:“last_name”,“sortType”:“DESC”}]
- page
- pass records per page value and page number
- e.g: [page] => {“recordsPerPage”:“3”,“pageNo”:“1”}
Response Body
Case 1: Data Retrieved Successfully
| Response Parameter | Value |
|---|---|
| success | 1 |
| Data | |
| id | ID of the student |
| first_name | First name of the student |
| last_name | Last name of the student |
| gender | gender |
| student_dob | date of birth in y-m-d format |
| address | address of the student |
| tc_number | transfer certificate number |
| image | Image URL |
| admission_number | admission number of the student |
| student_email | email of the student |
| student_contact | contact number of the student |
| blood_group | student blood group |
| profile_summary | profile summary of the student |
| allergies | List of allergies that the student has |
| medications | Medications prescribed to the student |
| medical_notes | Other medical notes for the student |
| text_36 | custom field |
| checkbox_37 | Custom checkbox field |
| student_name | Name of student |
| class_id | ID of the class to which the student belongs to |
| class_name | Name of the class |
| class_code | Code assigned to the class |
| section_id | ID of the section |
| section_name | Name of the section |
| section_code | Code assigned to the section |
| father_name | Father’s name |
| mother_name | Mother’s name |
| parents_contact | Parent’s contact number |
| parents_email | Parent’s email |
| country | Name of the country to which the student belongs |
| subjects | |
| subject_name | Name of the subject |
| type | Type of subject. Can be Core or Elective |
| id | subject ID |
Case 2: Invalid Parameters
| Response Parameter | Value |
|---|---|
| success | 0 |
| error | Invalid parameters |
Case 1: Data retrieved successfully
{
"success": 1
"data": [{"id":"54","first_name":"Hitesh","last_name":"Patel","gender":"Male","student_dob":"1992-06-07","address":"","tc_number":null,"image":"Image URL","admission_number":"33","student_email":"tohitehmca@gmail.com","student_contact":"9725656525","blood_group":"","profile_summary":"","allergies":null,"medications":null,"medical_notes":null,"text_36":null,"checkbox_37":"opt1,opt4","student_name":"Hitesh Patel","class_id":"2", "class_name":"Class - 2","class_code":"cls2","section_id"=>"3", "section_name":"Section - A (CLS2)","section_code":"2secA","father_name":"","mother_name":"","parents_contact":"9725656525","parents_email":"","country":"Country Name","subjects":[{"id":"29","subject_name":"Socail Science","type":"Core","class_name":"Class - 2","section_name":"Section - A (CLS2)"},{"id":"30","subject_name":"PT","type":"Elective","class_name":"Standared 8","section_name":"Section B"}]}]
}Case 2: Invalid parameters
{
"success": 0,
"error": "invalid_parameters",
}URL: https://demo.classe365.com/rest/student
Method: GET/POST
Parameters:
- data
- json encoded string of Student fields/attributes and related values
- For update, Student id should be passed in json encoded data string. If Student id is not found then it will insert the record.
- For class_id and section_id fields, class name and section name should be passed
- For profile_image field, base64 encoded string of related image should be passed
- All date values should be passed in Y-m-d format
- attachments (optional) (supported in insert only)
- json encoded string of attachment files
- Each attachment should have following attributes title - Attachment Name/Title description (optional) - Short description of the attachment file_type - Extension of attachment file file - base64 encodeded string of attachment file
- elective_subject_ids (optional)
- string of comma separated subjects ids of elective subjects which should be allocated (Note: Please make sure that you can only allocate the elective subjects to student through this api. You can’t unassing the elective subjects from student. To unassign the elective subjects, you need to use “Manage elective subjects allocation” API)
Example: Add Student
[ [data] => { “class_id”:“Grade 1”,
“section_id”:“Division A”,
“admission_number”:“2016_1_api”,
“first_name”:“Classe”,
“last_name”:“Developer”,
“student_dob”:“2000-05-08”,
“student_email”:"ggpatel77@gmail.com",
“contact”:“123123123”,
“image”: base64_encoded_string},
[attachments] => [
{“title”:“Attachment 1”,
“description”:“Test Attachment Upload using API”,
“file_type”:“pdf”,
“file”:base64_encoded_string } ],
[elective_subject_ids] => ‘6,8,12,26’ ]
Example: Update Student
[ [data] => {
“id”:“1”,
“class_id”:“Grade 1”,
“section_id”:“Division A”,
“admission_number”:“2016_1_api”,
“first_name”:“Classe”,
“last_name”:“Developer”,
“student_dob”:“2000-05-08”,
“student_email”:"ggpatel77@gmail.com",
“contact”:“123123123”,
“image”: base64_encoded_string }
]
Response Body
Case 1: Students Added or Updated successfully
This example shows the API output when the students are added or updated successfully. See Example 1.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 1 |
Case 2: Invalid Students ID
This example shows the API output when the student ID is invalid. See Example 2.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | invalid_id |
Case 3: Data Validation Error
This example shows the API output when there is a Data validation error. See Example 3.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | Returns field names that failed validation |
| required | |
| date | |
Case 4: Invalid Elective Subjects
This example shows the API output when elective subjects are invalid. See Example 4.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | Returns invalid elective subject_ids with the following status as applicable |
| invalid | |
| is_not_elective | |
| students_max_limit_crossed |
Case 5: Students Limit Exceeds for Class, Section, and System
This example shows the API output when student limit is exceeded. See Example 5.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | students_max_limit_crossed |
Case 6: Invalid Value for Profile Image
This example shows the API output when the profile image is invalid. See Example 6.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | binary_to_image_convert |
Case 7: Invalid Value for Attachments
This example shows the API output when the attachment is invalid. See Example 7.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | invalid_attachments |
Case 8: Attachments are not Supported in Update
This example shows the API output when elective subjects are invalid. See Example 8.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | attachments_not_supported_in_update |
Case 9: Elective Subjects are not Supported in Update
This example shows the API output when elective subjects are not supported during an update. See Example 9.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | elective_subject_ids_not_supported_in_update |
Case 1: Student added/updated successfully
{
"success": 1
}Case 2: Invalid Student id
{
"success": 0,
"error": "invalid_id",
}Case 3: Data validation error
{
"success": 0,
"error": "field_validations",
"field_validations": {
"field_id": required,
"field_id": email,
"field_id": date,
}
}Case 4: Invalid elective subjects
{
"success": 0,
"error": "invalid_elective_subject_ids",
"field_validations": {
"elective_subject_ids": invalid,
}
}
{
"success": 0,
"error": "invalid_elective_subject_ids",
"field_validations": {
"elective_subject_ids": is_not_elective,
}
}
{
"success": 0,
"error": "invalid_elective_subject_ids",
"field_validations": {
"elective_subject_ids": students_max_limit_crossed,
}
}
Case 5: Student limit crosses for class/section/system
{
"success": 0,
"error": "students_max_limit_crossed",
}Case 6: Invalid value for Profile image
{
"success": 0,
"error": "binary_to_image_convert",
}Case 7: Invalid value for Attachments
{
"success": 0,
"error": "invalid_attachments",
}Case 8: Attachments not support in update
{
"success": 0,
"error": "attachments_not_supported_in_update",
}Case 9: Elective Subjects not support in update
{
"success": 0,
"error": "elective_subject_ids_not_supported_in_update",
}URL: https://{subdomainName}.classe365.com/rest/electiveSubjectsAllocation
Method: POST
Parameters:
- student_id (id of student)
- to_be_assigned (optional if you are passing to_be_unassigned param. String of comma separated subjects ids of elective subjects which should be allocated to student)
- to_be_unassigned (optional if you are passing to_be_assigned param. String of comma separated subjects ids of elective subjects which should be unassigned to student)
Response Body
Case 1: Record updated successfully
This example shows the API output when a record is updated successfully . See Example 1.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 1 |
Case 2: Invalid parameters
This example shows the API output when parameters are invalid . See Example 2.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | invalid_parameters |
Case 3: Student is an alumni or student does not exist.
This example shows the API output when the student is an alumni or does not exist. See Example 3.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | invalid_student_id |
Case 4: Subjects are not elective subjects or do not exist.
This example shows the API output when the subjects are not elective subjects or do not exist. See Example 4.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | invalid_elective_subject_ids |
Case 5: Student limit is reached for subjects.
This example shows the API output when the student limit for the subjects is reached See Example 5.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | students_max_limit_crossed |
Case 6: Save error
This example shows the API output when there is an error while saving. See Example 6.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | save_error |
Case 1: Record updated successfully
{
"success": 1
}Case 2: Invalid parameters
{
"success": 0,
"error": "invalid_parameters",
}Case 3: Student is alumni or not exits.
{
"success": 0,
"error": "invalid_student_id",
}Case 4: Subjects is not elective subjects or not exits.
{
"success": 0,
"error": "invalid_elective_subject_ids",
}Case 5: Student limit is reached for subjects.
{
"success": 0,
"error": "students_max_limit_crossed",
}Case 6: Save error.
{
"success": 0,
"error": "save_error",
}This API allows you to retrieve teacher’s data.
URL: https://demo.classe365.com/rest/teachersData
Method: GET/POST
Parameters:
- filter
- json encoded string of Teachers fields/attributes and related values, for the fields we want to filter by
- All date values should be passed in Y-m-d format and with range structure for e.g. value for 1st Dec 2018 - “2018-12-01 to 2014-12-01” and value for 1st Dec 2018 to 10th Dec 2018 = “2018-12-01 to 2018-12-10”
Example
[filter] => {“id”:6,“first_name”:“Classe”,“last_name”:“Developer”,“teacher_dob”:“1992-06-07”,“teacher_email”:"",“gender”:"",“teacher_contact”:""}
- order
- pass field name and order type(ASC/DESC)
Example
[order] => {“sortField”:“first_name”,“sortType”:“DESC”},{“sortField”:“last_name”,“sortType”:“DESC”}
- page
- pass records per page value and page number
Example
[page] => {“recordsPerPage”:“3”,“pageNo”:“1”}
Response Body
Case 1: Data Retrieved Successfully
| Response Parameter | Value |
|---|---|
| success | returns a value of 1 on success |
| Data | |
| id | Teacher ID |
| first_name | First name of the teacher |
| last_name | |
| teacher_id | |
| address | Address of the teacher |
| zipcode | Zip code |
| state | State |
| aadhar_uid | Custom field. This is the Aadhar ID applicable in India |
| teacher_contact | Contact number |
| teacher_email | email of the teacher |
| image | profile image |
| designation | Custom field |
| qualification | Qualification |
| teacher_dob | Date of Birth of the teacher |
| age | Age |
| gender | |
| father_name | Father’s name |
| mother_name | Mother’s name |
| blood_group | blood group |
| health_date | Date of last health checkup |
| height | Height |
| weight | Weight |
| body_mass_index | Body mass Index |
| profile_summary | Profile summary |
| fb_profile_link | LInk to facebook profile |
| linkedin_profile_link | Link to Linkedin profile |
| is_academic | Is the teacher academic or non-academic |
| subjects | |
| subject_name | Name of the subject |
| type | Subject type - can be Core or Elective |
| class_name | Name of the class |
| section_name | Name of the section |
| id | subject ID |
| subject_name | Name of the subject |
| type | Can be core or elective |
Case 2: Invalid Parameters
This example shows the API output when parameters are invalid . See Example 2.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | invalid_parameters |
Case 1: Data retrieved successfully
{
"success": 1
"data": [{"id":"6","first_name":"Classe","last_name":"Teacher","teacher_id":"2016_2_api","address":null,"zipcode":null,"state":null,"aadhar_uid":null,"teacher_contact":"9725656525","teacher_email":"tohiteshmca@gmail.com","image":"http:\/\/classe365-assets.s3-us-west-1.amazonaws.com\/customer_assets\/local\/teacher\/profile_pictures\/1543034963.jpg","designation":null,"qualification":null,"teacher_dob":"1992-06-07","age":null,"gender":"Male","father_name":null,"mother_name":null,"blood_group":null,"health_date":null,"height":null,"weight":null,"body_mass_index":null,"profile_summary":null,"fb_profile_link":null,"linkedin_profile_link":null,"is_academic":"1","text_20":"Test","teacher_name":"Classe Teacher","country":"","subjects":[{"id":"1","subject_name":"Account","type":"Core","class_name":"Standared 12","section_name":"Commerce"},{"id":"2","subject_name":"State","type":"Elective","class_name":"Standared 12","section_name":"Commerce"}]}]
}Case 2: Invalid parameters
{
"success": 0,
"error": "invalid_parameters",
}This API allows you to add or update teachers.
URL: https://demo.classe365.com/rest/teacher
Method: GET/POST
Parameters:
- data
- json encoded string of Teachers fields/attributes and related values
- For update, Teachers id should be passed in json encoded data string. If Teachers id is not found then it will insert the record.
- For profile_image field, base64 encoded string of related image should be passed
- All date values should be passed in Y-m-d format
Example: Add Teachers
[[data] => {"teacher_id":"2016_1_api","first_name":"Classe","last_name":"Developer","teacher_dob":"2000-05-08","teacher_email":"tohiteshmca@gmail.com","teacher_contact":"9725656525","image": base64_encoded_string}]
Example: Update Teachers
[[data] => {"id":"1","teacher_id":"2016_1_api","first_name":"Classe","last_name":"Developer","teacher_dob":"2000-05-08","teacher_email":"tohiteshmca@gmail.com","teacher_contact":"9725656525","image": base64_encoded_string}]
Response Body
Case 1: Teacher added or updated successfully
This example shows the API output when the student ID is invalid. See Example 1.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 1 |
Case 2: Invalid Student ID
This example shows the API output when the student ID is invalid. See Example 2.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | invalid_id |
Case 3: Data Validation Error
This example shows the API output when there is a Data validation error . See Example 3.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | Returns field names that failed validation |
| required | |
| date | |
| Unique | |
Case 4: Invalid Profile Image
This example shows the API output when the profile image is invalid. See Example 4.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | binary_to_image_convert |
Case 1: Teachers added or updated successfully
{
"success": 1
}Case 2: Invalid Student ID
{
"success": 0,
"error": "invalid_id",
}Case 3: Data validation error
{
"success": 0,
"error": "field_validations",
"field_validations": {
"field_id": required,
"field_id": email,
"field_id": date,
"field_id": unique,
}
}Case 4: Invalid value for Profile image
{
"success": 0,
"error": "binary_to_image_convert",
}URL: https://demo.classe365.com/rest/adminsData
Method: GET/POST
Parameters:
-
filter
- json encoded string of admin fields and related values, for the fields we want to filter by
Example
[filter] => {“name”:“Hitz”,“email_address”:"",“contact”:"",“main_admin”:“0”,“address”:""}
-
order
- pass field name and order type (ASC/DESC)
Example
[order] => [{“sortField”:“first_name”,“sortType”:“DESC”},{“sortField”:“last_name”,“sortType”:“DESC”}]
-
page
- pass records per page value and page number
Example
[page] => {“recordsPerPage”:“3”,“pageNo”:“1”}
Response Body
Case 1: Data Retrieved Successfully
The table below gives the description of the results appear when data is retrieved successfully. See Example 1.
| Response Parameter | Value |
|---|---|
| success | Indicates success with a value of 1 |
| Data | |
| ID | ID of the admin. |
| name | Name of the admin |
| email_address | Email of the admin |
| contact | Contact number of the admin |
| image | Profile image |
| main_admin | Indicates if the admin is a main admin or not |
| address | Address |
Case 2: Invalid Parameters
The table below gives the description of the status that appears when data is not found. See Example 2.
| Response Parameter | Value |
|---|---|
| success | Value is 0 |
| strong texterror | invalid_parameters |
Case 1: Data retrieved successfully
{
"success": 1
"data": [{"id":"2","name":"Hitz (Sub)","email_address":"hiteshpatel7692@gmail.com","contact":"9725656525","image":"http:\/\/classe365-assets.s3-us-west-1.amazonaws.com\/customer_assets\/local\/admin\/profile_pictures\/1506668090.png","main_admin":"0","address":"HMT"}]
}Case 2: Invalid parameters
{
"success": 0,
"error": "invalid_parameters",
}URL: https://demo.classe365.com/rest/admin
Method: GET/POST
Parameters:
- data
- json encoded string of admin fields and related values
- Update admin detail then pass admin id in json encoded string.
- For profile_image field, base64 encoded string of related image should be passed
- e.g: Add admin: [[data] => {“name”:“Hitesh”,“email_address”:“mail@mail.com”,“contact”:“3862”,“address”:“ad”,“image”: base64_encoded_string}]
- e.g: Update admin: [[data] => {“id”:“1”,“name”:“Hitesh”,“email_address”:“mail@mail.com”,“contact”:“3862”,“address”:“ad”,“image”: base64_encoded_string}]
Response Body
Case 1: Admin Added or Updated Successfully
| Response Parameter | Value |
|---|---|
| success | Returns a value of 1 |
Case 2: Data Validation Error
This example shows the API output when there is a Data validation error . See Example 3.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | Returns field names that failed validation |
| invalid_id | |
| required | |
| unique | |
Case 3: Invalid Value for Profile Image
This example shows the API output when the profile image is invalid. See Example 3.
| Response Parameter | Value |
|---|---|
| success | Returns a value of 0 |
| error | binary-to_image_convert |
Case 1: Admin added/updated successfully
{
"success": 1
}Case 2: Data validation error
{
"success": 0,
"error": "field_validations",
"field_validations": {
"field_id": invalid_id,
"field_id": required,
"field_id": email,
"field_id": unique,
}
}Case 3: Invalid value for Profile image
{
"success": 0,
"error": "binary_to_image_convert",
}URL: https://{subdomainName}.classe365.com/rest/studentScore Method: GET
Parameters:
- id (id of student)
Response Body
Case 1: Data retrieved successfully (Grading Periods enabled)
| Response Parameter | Value |
|---|---|
| success | returns a value of 1 on success |
| Data | |
| subject | |
| subject_name | Name of Subject. |
| credits | Number of credit hours for this subject. |
| type | Type of subject. Can be Core or Elective. |
| unpublished_score_value | Unpublished score. |
| published_score_value | Published score. |
| dis_unpublished_score_value | |
| dis_published_score_value | |
| Grading Periods | |
| grading_period_id | ID of the grading period. |
| name | Name of the grading period |
| weight | Weight assigned to the grading period. |
| weighted | |
| unpublished_score_value | Unpublished score. |
| published_score_value | Published score. |
| dis_unpublished_score_value | |
| dis_published_score_value | |
| comment | |
| Assessments | |
| assessment_id | ID of the assessments. |
| name | Name of the assessment. |
| ass_cat_id | ID of the assessment category to which this assessments belongs. |
| ass_cat_name | ID of the assessment category to which this assessments belongs. |
| points | Number of points assigned to the assessment. |
| pass_points | Passing points. |
| start_date | Start date for the assessment. |
| end_date | Start date for the assessment. |
| grading_period_id | ID of the grading period for this assessment. |
| counts_in_overall | Indicates whether this score is counted towards the overall score. |
| weight | Weight allocated to this assessment. |
| is_published | Indicates whether this assessment is published for use. |
| scale_type | Indicates the scale type – percentage, points and so on. |
| score | Indicates the score. |
| dis_score | |
| comment | Comments for this assessment. |
Case 1: Data retrieved successfully (Grading Periods enabled)
{
"success": 1,
"data": {
{
"subject": {
"subject_name": Math,
"credits": 6,
"type": Core,
"unpublished_score_value": 75.55,
"published_score_value": 73.2,
"dis_unpublished_score_value": 75.55%,
"dis_published_score_value": 73.2%,
},
"grading_periods": {
{
"grading_period_id": 3,
"name": GP 1 Jan - May,
"weight": 40,
"weighted": 40,
"unpublished_score_value": 80.23,
"published_score_value": 79.98,
"dis_unpublished_score_value": 80.23%,
"dis_published_score_value": 79.98%,
"comment": ,
},
{
"grading_period_id": 4,
"name": GP 2 Jun - Oct,
"weight": 40,
"weighted": 40,
"unpublished_score_value": '',
"published_score_value": '',
"dis_unpublished_score_value": '',
"dis_published_score_value": '',
"comment": ,
},
},
"assessments": {
{
"assessment_id": 10
"name": Mid Exam,
"ass_cat_id": 1,
"ass_cat_name": Exam,
"points": 30,
"pass_points": 15,
"start_date": null,
"end_date": null,
"grading_period_id": 3,
"counts_in_overall": Yes,
"weight": 10,
"is_published": Yes,
"scale_type": Percentage,
"score": 22,
"dis_score": 73.33%,
"comment": ,
},
{
"assessment_id": 4,
"name": Project 1,
"ass_cat_id": 2,
"ass_cat_name": Assignment Project,
"points": 30,
"pass_points": 15,
"start_date": null,
"end_date": null,
"grading_period_id": 3,
"counts_in_overall": Yes,
"weight": 10,
"is_published": Yes,
"scale_type": Percentage,
"score": 25,
"dis_score": 83.33%,
"comment": ,
},
....
}
},
....
}
}Case 2: Data retrieved successfully (Without Grading Periods)
{
"success": 1,
"data": {
{
"subject": {
"subject_id": 1,
"subject_name": Math,
"credits": 6,
"type": Core,
"unpublished_score_value": 75.55,
"published_score_value": 73.2,
"dis_unpublished_score_value": 75.55%,
"dis_published_score_value": 73.2%,
"comment": ,
},
"assessments": {
{
"assessment_id": 10,
"name": Mid Exam,
"ass_cat_id": 1,
"ass_cat_name": Exam,
"points": 30,
"pass_points": 15,
"start_date": null,
"end_date": null,
"counts_in_overall": Yes,
"weight": 10,
"is_published": Yes,
"scale_type": Percentage,
"score": 22,
"dis_score": 73.33%,
"comment": ,
},
{
"assessment_id": 4,
"name": Project 1,
"ass_cat_id": 2,
"ass_cat_name": Assignment Project,
"points": 30,
"pass_points": 15,
"start_date": null,
"end_date": null,
"counts_in_overall": Yes,
"weight": 10,
"is_published": No,
"scale_type": Percentage,
"score": 25,
"dis_score": 83.33%,
"comment": ,
},
....
}
},
....
}
}Case 3: Invalid parameters
{
"success": 0,
"error": "invalid_parameters",
}Case 4: Data not found
{
"success": 0,
"error": "no_record_found",
}Case 5: Error occurred while retrieving data
{
"success": 0,
"error": "read_error",
}URI: https://{subdomainName}.classe365.com/rest/subjectScore Method: GET
Parameters:
- id (id of subjects)
Response Body
Case 1: Data retrieved successfully (Grading Periods Enabled)
| Response Parameter | Value |
|---|---|
| success | returns a value of 1 on success |
| Data | |
| subject | Name of the subject. |
| subject_id | ID assigned to the subject |
| subject_name | Name of the subject |
| credits | NUmber of credit hours assigned to the subject |
| type | Type of the subject - can be core or elective |
| Grading Periods | |
| grading_period_id | ID of the grading period |
| name | Name of the grading period |
| weight | Weight allocated to the subject |
| Overall Score | |
| student_id | ID of the student |
| student_first_name | First name of the student |
| student_last_name | Last name of the student |
| student_admission_no | Admission number of the student |
| is_alumni | Indicates whether the student is an alumni or not |
| unpublished_score_value | Unpublished score |
| published_score_value | Published score |
| dis_unpublished_score_value | |
| dis_published_score_value | |
| comment | Comments |
| Assessments | |
| assessment_id | ID of the assessments |
| name | Name of the assessment |
| ass_cat_id | ID of the assessment category |
| ass_cat_name | Name of the assessment category |
| points | Points assigned |
| pass_points | Points required to pass the assessment |
| start_date | Start date of the assessment |
| end_date | Start date of the assessment |
| counts_in_overall | Indicates whether the grades are counted in the overall score |
| weight | Weight assigned to the assessment |
| is_published | Indicates whether the assessment is published or not |
| scale_type | Type of grading scale - can be percentage, rubric, manual etc |
| Score | |
| actual_score_value | Actual score |
| display_score_value | Display value of the score |
Case 2: Data retrieved successfully (Grading Periods Disabled)
| Response Parameter | Value |
|---|---|
| success | returns a value of 1 on success |
| Data | |
| subject | Name of the subject. |
| subject_id | ID assigned to the subject |
| subject_name | Name of the subject |
| credits | NUmber of credit hours assigned to the subject |
| type | Type of the subject - can be core or elective |
| Overall Score | |
| student_id | ID of the student |
| student_first_name | First name of the student |
| student_last_name | Last name of the student |
| student_admission_no | Admission number of the student |
| is_alumni | Indicates whether the student is an alumni or not |
| unpublished_score_value | Unpublished score |
| published_score_value | Published score |
| dis_unpublished_score_value | |
| dis_published_score_value | |
| comment | Comments |
| Assessments | |
| assessment_id | ID of the assessments |
| name | Name of the assessment |
| ass_cat_id | ID of the assessment category |
| ass_cat_name | Name of the assessment category |
| points | Points assigned |
| pass_points | Points required to pass the assessment |
| start_date | Start date of the assessment |
| end_date | Start date of the assessment |
| counts_in_overall | Indicates whether the grades are counted in the overall score |
| weight | Weight assigned to the assessment |
| is_published | Indicates whether the assessment is published or not |
| scale_type | Type of grading scale - can be percentage, rubric, manual etc |
| Score | |
| actual_score_value | Actual score |
| display_score_value | Display value of the score |
Case 3: Invalid Parameters
The table below gives the description of the status that appears when parameters are invalid See Example 3.
| Response Parameter | Value |
|---|---|
| success | Value is 0 |
| error | invalid_parameters |
Case 4: Data not Found
The table below gives the description of the status that appears when parameters are invalid See Example 4.
| Response Parameter | Value |
|---|---|
| success | Value is 0 |
| error | no_record_found |
Case 5: Error while Retrieving Data
The table below gives the description of the error that appears when during retrieval of data. See Example 5.
| Response Parameter | Value |
|---|---|
| success | Value is 0 |
| error | read_error |
Case 1: Data retrieved successfully (Grading Periods enabled)
{
"success": 1,
"data": {
"subject": {
"subject_id": 1,
"subject_name": Math,
"credits": 6,
"type": Core,
},
"grading_periods": {
{
"grading_period_id": 3,
"name": GP 1 Jan - May,
"weight": 40,
"weighted": 40,
},
{
"grading_period_id": 4,
"name": GP 2 Jun - Oct,
"weight": 40,
"weighted": 40,
},
},
"overall_score": { // grading period id as key..
"3": {
{
"student_id": 45,
"student_first_name": Cindy,
"student_last_name": Hanson,
"student_admission_no": 2019001,
"is_alumni": No,
"unpublished_score_value": 85.33,
"published_score_value": 70.20,
"dis_unpublished_score_value": 85.33%,
"dis_published_score_value": 70.20%,
"comment": ,
},
{
"student_id": 40,
"student_first_name": Ben,
"student_last_name": Gerber,
"student_admission_no": 2019002,
"is_alumni": No,
"unpublished_score_value": 75.25,
"published_score_value": 70.00,
"dis_unpublished_score_value": 75.25%,
"dis_published_score_value": 70.00%,
"comment": ,
},
....
},
"4": {
{
"student_id": 45,
"student_first_name": Cindy,
"student_last_name": Hanson,
"student_admission_no": 2019001,
"is_alumni": No,
"unpublished_score_value": 62.33,
"published_score_value": 60.20,
"dis_unpublished_score_value": 62.33%,
"dis_published_score_value": 60.20%,
"comment": ,
},
{
"student_id": 40,
"student_first_name": Ben,
"student_last_name": Gerber,
"student_admission_no": 2019002,
"is_alumni": No,
"unpublished_score_value": 80.25,
"published_score_value": 75.00,
"dis_unpublished_score_value": 80.25%,
"dis_published_score_value": 75.00%,
"comment": ,
},
....
},
},
"assessments": {
{
"assessment_id": 10,
"name": Mid Exam,
"ass_cat_id": 1,
"ass_cat_name": Exam,
"points": 30,
"pass_points": 15,
"start_date": null,
"end_date": null,
"grading_period_id": 3,
"counts_in_overall": Yes,
"weight": 10,
"is_published": Yes,
"scale_type": Percentage,
"score": {
{
"student_id": 45,
"student_first_name": Cindy,
"student_last_name": Hanson,
"student_admission_no": 2019001,
"is_alumni": No,
"actual_score_value": 15,
"display_score_value": 50%,
"comment": ,
},
{
"student_id": 40,
"student_first_name": Ben,
"student_last_name": Gerber,
"student_admission_no": 2019002,
"is_alumni": No,
"actual_score_value": 15,
"display_score_value": 50%,
"comment": ,
},
....
}
},
{
"assessment_id": 4,
"name": Project 1,
"ass_cat_id": 2,
"ass_cat_name": Assignment Project,
"points": 30,
"pass_points": 15,
"start_date": null,
"end_date": null,
"grading_period_id": 3,
"counts_in_overall": Yes,
"weight": 10,
"is_published": No,
"scale_type": Percentage,
"score": {
{
"student_id": 45,
"student_first_name": Cindy,
"student_last_name": Hanson,
"student_admission_no": 2019001,
"is_alumni": No,
"actual_score_value": 15,
"display_score_value": 50%,
"comment": ,
},
{
"student_id": 40,
"student_first_name": Ben,
"student_last_name": Gerber,
"student_admission_no": 2019002,
"is_alumni": No,
"actual_score_value": 15,
"display_score_value": 50%,
"comment": ,
},
....
}
},
....
},
}
}Case 2: Data retrieved successfully (Without Grading Periods)
{
"success": 1,
"data": {
"subject": {
"subject_id": 1,
"subject_name": Math,
"credits": 6,
"type": Core,
},
"overall_score": { // If grading periods are disabled just one element in this array with key value 0
"0": {
{
"student_id": 45,
"student_first_name": Cindy,
"student_last_name": Hanson,
"student_admission_no": 2019001,
"is_alumni": No,
"unpublished_score_value": 85.33,
"published_score_value": 70.20,
"dis_unpublished_score_value": 85.33%,
"dis_published_score_value": 70.20,
"comment": ,
},
{
"student_id": 40,
"student_first_name": Ben,
"student_last_name": Gerber,
"student_admission_no": 2019002,
"is_alumni": No,
"unpublished_score_value": 75.25,
"published_score_value": 70.00,
"dis_unpublished_score_value": 75.25%,
"dis_published_score_value": 70.00%,
"comment": ,
},
....
}
},
"assessments": {
{
"assessment_id": 10,
"name": Mid Exam,
"ass_cat_id": 1,
"ass_cat_name": Exam,
"points": 30,
"pass_points": 15,
"start_date": null,
"end_date": null,
"counts_in_overall": Yes,
"weight": 10,
"is_published": Yes,
"scale_type": Percentage,
"score": {
{
"student_id": 45,
"student_first_name": Cindy,
"student_last_name": Hanson,
"student_admission_no": 2019001,
"is_alumni": No,
"actual_score_value": 15,
"display_score_value": 50%,
"comment": ,
},
{
"student_id": 40,
"student_first_name": Ben,
"student_last_name": Gerber,
"student_admission_no": 2019002,
"is_alumni": No,
"actual_score_value": 15,
"display_score_value": 50%,
"comment": ,
},
....
}
},
{
"assessment_id": 4,
"name": Project 1,
"ass_cat_id": 2,
"ass_cat_name": Assignment Project,
"points": 30,
"pass_points": 15,
"start_date": null,
"end_date": null,
"counts_in_overall": Yes,
"weight": 10,
"is_published": No,
"scale_type": Percentage,
"score": {
{
"student_id": 45,
"student_first_name": Cindy,
"student_last_name": Hanson,
"student_admission_no": 2019001,
"is_alumni": No,
"actual_score_value": 15,
"display_score_value": 50%,
"comment": ,
},
{
"student_id": 40,
"student_first_name": Ben,
"student_last_name": Gerber,
"student_admission_no": 2019002,
"is_alumni": No,
"actual_score_value": 15,
"display_score_value": 50%,
"comment": ,
},
....
}
},
....
},
}
}Case 3: Invalid parameters
{
"success": 0,
"error": "invalid_parameters",
}Case 4: Data not found
{
"success": 0,
"error": "no_record_found",
}Case 5: Error occurred while retrieving data
{
"success": 0,
"error": "read_error",
}URI: https://{subdomainName}.classe365.com/rest/saveAssessmentScore Method: POST
Parameters:
-
assessment_id (id of assessment)
-
subject_id (id of subjects)
-
score_data (json encoded string of obtained scores.)
-
format
[‘score_data’] =>{“student_id”:{“score”:“score_value”,“comment”:“comment_text”,“status”:“status_vlaue”}};
Note: If you are passing score value then you need to pass status value as an empty string. And vice versa, if you are passing status value then pass score value as an empty string.
Example
[‘score_data’] =>{“45”:{“score”:“20”,“comment”:“Good”,“status”:""},“48”:{“score”:“10”,“comment”:“Poor Performance”,“status”:""},“53”:{“score”:"",“comment”:"",“status”:“EXE”}};
-
Supported Status: DS, I, EX, RPL, EXE, RS, RT, CR
Response Body
Case 1: Data Saved Successfully
-
The table below gives the description of the status that appears when data is saved successfully. See Example 1.
| Response Parameter | Value |
|---|---|
| success | Value is 1 |
Case 2: Invalid parameters
The table below gives the description of the status that appears when parameters are invalid. See Example 2.
| Response Parameter | Value |
|---|---|
| success | Value is 0 |
| error | invalid_parameters |
Case 3: Invalid assessment id
The table below gives the description of the status that appears when data is saved successfully. See Example 3.
| Response Parameter | Value |
|---|---|
| success | Value is 0 |
| error | invalid_assessment_id |
Case 4: Assessment not applicable on subjects
The table below gives the description of the status that appears when data is saved successfully. See Example 4.
| Response Parameter | Value |
|---|---|
| success | Value is 0 |
| error | invalid_assessment_id_and_subject_id |
Case 5: Invalid assessment score data
The table below gives the description of the status that appears when data is saved successfully. See Example 5.
| Response Parameter | Value |
|---|---|
| success | Value is 0 |
| error | invalid_score_data |
Case 6: Invalid assessment score data
The table below gives the description of the status that appears when data is saved successfully. See Example 6.
| Response Parameter | Value |
|---|---|
| success | Value is 0 |
| error | save_error |
Case 1: Data saved successfully
{
"success": 1
}Case 2: Invalid parameters
{
"success": 0,
"error": "invalid_parameters",
}Case 3: Invalid assessment id.
{
"success": 0,
"error": "invalid_assessment_id",
}Case 4: Assessment not applicable on subjects.
{
"success": 0,
"error": "invalid_assessment_id_and_subject_id",
}Case 5: Invalid assessment score data.
{
"success": 0,
"error": "invalid_score_data",
}Case 6: Error! While saving assessment score data.
{
"success": 0,
"error": "save_error",
}