All requests must be authenticated to function, by use of the api key style.
Method | CMD | Properties | CMD Properties | Response |
---|---|---|---|---|
Assign Subscription | assign_subscription |
|
|
Boolean |
Reactivate Subscription | reactivate_subscription |
|
|
Boolean and Message |
Login Parent | loginparent |
|
|
Boolean and Student/Subscription Info |
Get lessons | getLessons |
|
|
Boolean and Lesson data with answers |
Get Table | gettable |
|
|
Boolean and table data determined by requested table name |
May Assign | may_assign_student |
|
|
Boolean and a message code for determining the assignment status for the sub and student. |
Change Password | change_password |
|
|
Boolean |
Update Student Nickname | update_student_nickname |
|
|
Boolean |
Update Problem | parent_problem_update |
|
|
Boolean |
Lesson Priority List | check_lesson_priority |
|
|
List of priorities divided by the given student id collection |
Lesson Delete | delete_lesson |
|
|
Boolean |
Pause Subscription | pause_sub |
|
|
Boolean and a list of pause responses |
Problem Delete | delete_problem |
|
|
Boolean |
Student Submit Answer | submit_student_answer |
|
|
Boolean |
Submit Student View | submit_student_view |
|
|
Boolean |
Student Create | create_student |
|
|
Boolean |
Student Create Assign Subscription | create_student_and_assign_sub |
|
|
Boolean |
Free Trial Upgrade | freetrialupgrade |
|
|
Boolean and Data on the subscription |
Remove Free Trial | remove_free_trial |
|
|
Boolean and data on the targeted subscription |
Send Log | sendlogtoserver |
|
|
Boolean |
Send Debug Log | send_debug_log |
|
|
ID of record created. Any response of 0 is a failure. |
Clear Lessons | clearLessons |
|
|
Boolean |
Get Subscription Info | getsubinfo |
|
|
Boolean and student/subscription data for the requested parent and product. |
Sync lesson grade data | getLessonGradeData |
|
|
Boolean and list of missing or newer records to update on the device |
Sync quiz grade data | getQuizGradeData |
|
|
Boolean and list of missing or newer records to update on the device |
Save Preferences | save_preferences |
|
|
Boolean and the updated subscription data |
Get Sketches | getsketchdata |
|
|
Boolean and the requested sketch data |
Save Sketches | save_sketch |
|
|
Boolean and if server data is newer than it will contain that new data record. |
Submit Bonus Round | submit_bonus_round |
|
|
If the submission was successful, returns the string “OK [points]” where [points] is the number of bonus points the student earned. Possible values 0, 1, 2, 3, or 4. |
Change Parent pass | change_parent_pass |
|
|
The endpoint will return the string OK if the password was successfully changed, or ERR [Description of error] if unsuccessful. |
Forgot Parent pass | forgot_parent_pass |
|
|
The endpoint will return the string OK if the reset email was successfully sent, or ERR [Description of error] if unsuccessful. |
Sync Sketch Data | syncSketchData |
|
|
The endpoint will return a response message with a sketchdata containing an object with product, studentId, subscription, and a list of sketch data records in a format for flash. |
Get Parent Email | getparentemail |
|
|
The endpoint will return a response message with the current email of the given parent Id. |
Get App Info | getAppInfo |
|
|
The endpoint will return a response message with a course data object containing MinVersion, Product, NewVersion, LTI, ID, Appendix values. |
Reset Bonus Grade | resetBonusGrade |
|
|
The endpoint will return a response message with an ok or error message if the functional call is successful on database. |
Verify ETags | VerifyEtags |
|
|
The endpoint will respond with a return of count of etags and a list of etags not found in the database. |
Verify Wallpapers | VerifyWallpapers |
|
|
The endpoint will respond back with a flag if data should be updated and include the required data to insert. Ids in the csv will be excluded from the return and only matched non-passed in records will return in the data structure. |
Subscription Permissions | getSubscriptionAccess |
|
|
The endpoint will respond back with a data object with permissions inside it. These permissions will include edit, view, and an informative message. |