Data
| API | Description |
|---|---|
| POST api/data |
No documentation available. |
| GET api/data?teamId={teamId}&storyNumber={storyNumber} |
No documentation available. |
PowerReader
| API | Description |
|---|---|
| GET api/Activity/PowerReader/StoryList?storyId={storyId} |
Returns a list of previous 6 stories for the given story Id - alternate rules apply for stories 4-9 |
| GET api/Activity/PowerReader/Story?storyId={storyId} |
Returns the complete story text - each word is wrapped in a span with a class and an Id - the Id is the word count for that page |
| PUT api/Activity/PowerReader |
Sets the activity status, at the end of an activity it can be set as complete or incomplete. Saves a session count for each student if a student already has a session for the days activities then no session will be updated. |
Rewards
| API | Description |
|---|---|
| PUT api/Rewards/Add |
Updates team reward points. |
| PUT api/Rewards/Use |
Updates team reward points. |
| GET api/Rewards/Get?teamId={teamId} |
No documentation available. |
Student
Controller to handle student record functions.
| API | Description |
|---|---|
| GET api/Student?schoolId={schoolId} |
No documentation available. |
| GET api/StudentAllCertificate |
No documentation available. |
| GET api/StudentsForStaff?staffId={staffId} |
No documentation available. |
| GET api/CertificatePrint?certificateId={certificateId} |
No documentation available. |
| PUT api/Student |
No documentation available. |
| PUT api/Student/SetActiveStatus |
No documentation available. |
| DELETE api/Student |
No documentation available. |
| POST api/Student |
No documentation available. |
| GET api/Student/Transfer?studentId={studentId}&schoolId={schoolId} |
No documentation available. |
| GET api/StudentAttendance?schoolId={schoolId} |
No documentation available. |
| POST api/SaveStudentAttendance |
No documentation available. |
| GET api/StudentAttendanceTypes |
No documentation available. |
| GET api/DeactivationReasons |
No documentation available. |
Organization
| API | Description |
|---|---|
| GET api/StoryList |
No documentation available. |
| GET api/ResourceList |
No documentation available. |
| GET api/SchoolList |
No documentation available. |
| GET api/StaffList |
No documentation available. |
| GET api/AllStaffList |
No documentation available. |
Assessment
Controller to change schedules related to the user.
| API | Description |
|---|---|
| GET api/Assessment?groupnumber={groupnumber} |
Returns assessment words and group rules. GroupNumber is nullable pass 0-14 for individual groups or null value for all groups |
| POST api/Assessment |
Saves student mastery, StudentId and Masterylevel are required. MasteryLevel is limited to 4-70 |
StoryQuest
| API | Description |
|---|---|
| PUT api/Activity/StoryQuest |
Sets the activity status, at the end of an activity it can be set as complete or incomplete. Saves a session count for each student if a student already has a session for the days activities then no session will be updated. |
| PUT api/Activity/StoryQuest/FreePlay |
No documentation available. |
| GET api/Activity/StoryQuest?teamId={teamId} |
Gets the complete page , answer, question data package for the story |
| GET api/Activity/StoryQuest/Story?storyId={storyId} |
Gets the complete page , answer, question data package for the story |
| GET api/Activity/StoryQuest/StoryList?storyId={storyId} |
Returns a list of previous 3 stories for the given story Id - alternate rules apply for stories 4-9 |
Report
| API | Description |
|---|---|
| GET api/Report/TutorSummary?staffId={staffId}¤tYear={currentYear}&from={from}&to={to}&active={active}&schoolId={schoolId} |
No documentation available. |
| GET api/Report/TutorSummary?currentYear={currentYear}&from={from}&to={to}&active={active}&schoolId={schoolId} |
No documentation available. |
| GET api/Report/DistrictSummary?currentYear={currentYear}&from={from}&to={to}&active={active} |
No documentation available. |
| GET api/Report/SchoolSummary?schoolId={schoolId}¤tYear={currentYear}&from={from}&to={to}&active={active} |
No documentation available. |
| GET api/Report/PPN?studentId={studentId}¤tYear={currentYear}&from={from}&to={to}&active={active} |
No documentation available. |
| POST api/Report/OpenResponse |
No documentation available. |
| POST api/Report/StudentAttendance |
No documentation available. |
| POST api/Report/StudentDeactivation |
No documentation available. |
Session
| API | Description |
|---|---|
| PUT api/Session |
No documentation available. |
School
| API | Description |
|---|---|
| POST api/School |
No documentation available. |
| GET api/School?districtId={districtId} |
No documentation available. |
| PATCH api/School |
No documentation available. |
Tutor
| API | Description |
|---|---|
| GET api/Tutor |
Returns account information for the authenticated user |
| GET api/Tutor?activationid={activationid} |
Returns user information to be used when activating an account. |
| POST api/Tutor/Activate?activationid={activationid} |
User account setup, create password and user name using activation key(sent to user via Email). The activation key will be caught by the front end, then used to both get users basic information and to activate the user account |
Team
Team
| API | Description |
|---|---|
| GET api/Team?schoolId={schoolId} |
No documentation available. |
| GET api/Dashboard?schoolId={schoolId} |
No documentation available. |
| POST api/Team |
Creates a team based on valid student id array. Students can only belong to the authenticated user Student Collection count must = 2 Any student can not be already associated with a team |
| PUT api/Team |
Updates team information. Set Team Mastery Range 4-70, assign TimeSlotId. Mastery is always required even if it does not change |
| PUT api/Team/Setup |
Setup the team, set the team color and the student avatars |
| DELETE api/Team |
Dissolves the team. |
Integration
| API | Description |
|---|---|
| POST api/integration/receiveTransfer |
No documentation available. |
TutorCheck
| API | Description |
|---|---|
| POST api/Activity/TutorCheck/SetWcpm |
No documentation available. |
| POST api/Activity/TutorCheck/EndCheck |
Save team status of tutor check complete = true: advances the team to the next story, saves mastery history for previous story complete = false: team stays at current story, activity statuses reset so all activities are active again |
| GET api/Activity/TutorCheck?storyId={storyId}&teamId={teamId} |
No documentation available. |
Schedule
Controller to change schedules related to the user.
| API | Description |
|---|---|
| PUT api/Tutor/Schedule/RemoveTeam |
Removes a specified team from it's assigned time slot. |
| DELETE api/Tutor/Schedule/All?schoolId={schoolId} |
No documentation available. |
| POST api/Tutor/Schedule |
Creates the schedule, adds time slots to collection. Time values can not overlap, however one slots end time can be the same as the next slots beginning time. |
| GET api/Tutor/Schedule?schoolId={schoolId} |
No documentation available. |
| DELETE api/Tutor/Schedule |
Deletes the times lot specified by the given id. Requires the removal of any teams assigned to the time slot |
WordQuest
| API | Description |
|---|---|
| PUT api/Activity/WordQuest |
Sets the activity status, at the end of an activity it can be set as complete or incomplete. Saves a session count for each student if a student already has a session for the days activities then no session will be updated. |
| PUT api/Activity/WordQuest/FreePlay |
No documentation available. |
| GET api/Activity/WordQuest?teamId={teamId} |
Gets Story Details and word list for the specified story number. |
| GET api/Activity/WordQuest/Story?storyId={storyId} |
No documentation available. |
Forgot
| API | Description |
|---|---|
| POST api/Forgot |
Sends user name and a password reset URL to the users registered email account, password reset token is valid for 24 hours and can only be used once |
| POST api/Forgot/Reset |
Saves users new password using a valid password reset token. |
District
| API | Description |
|---|---|
| POST api/District |
No documentation available. |
| GET api/District |
No documentation available. |
| PATCH api/District |
No documentation available. |
StudentTransfer
| API | Description |
|---|---|
| GET api/StudentTransfer/Teams?staffId={staffId} |
No documentation available. |
| GET api/StudentTransfer/AllStaff |
No documentation available. |
| DELETE api/StudentTransfer/DissolveTeam?staffId={staffId}&teamId={teamId} |
No documentation available. |
| PUT api/StudentTransfer/MoveTeam |
No documentation available. |
| PUT api/StudentTransfer/MoveStudents |
No documentation available. |
Import
| API | Description |
|---|---|
| POST api/import/process |
No documentation available. |
Staff
| API | Description |
|---|---|
| GET api/staff/AllStaff |
No documentation available. |
| PUT api/staff/ActivationMessage?staffId={staffId} |
No documentation available. |
| DELETE api/staff/delete?staffId={staffId} |
No documentation available. |
| POST api/staff/add |
No documentation available. |
| PUT api/staff/update |
No documentation available. |
| GET api/staff/AssignedSchools?staffId={staffId} |
No documentation available. |
| POST api/staff/addAssignedSchool?schoolId={schoolId}&staffId={staffId} |
No documentation available. |
| DELETE api/staff/removeAssignedSchool?schoolId={schoolId}&staffId={staffId} |
No documentation available. |
| PUT api/staff/active?staffId={staffId} |
No documentation available. |
| GET api/staff/UserDetails?staffId={staffId} |
No documentation available. |
ApiInfo
| API | Description |
|---|---|
| GET api/time |
No documentation available. |
| GET api/welcomePageTemplate |
No documentation available. |
| GET api/forgotPageTemplate |
No documentation available. |
| GET api/parseJwt?jwt={jwt} |
No documentation available. |
| GET api/ApiInfo |
No documentation available. |
MemberCenterImport
Handles the importing of Student Information into LS from MC
| API | Description |
|---|---|
| GET api/MemberCenterImport?schoolId={schoolId} |
Gets list of tutors for the specified school |
| POST api/MemberCenterImport?tutorId={tutorId}&mcStudentId={mcStudentId} |
No documentation available. |