Edinsight
| API | Description |
|---|---|
| GET api/getEdinsightDistricts |
Get all EdInsight Districts |
| GET api/getEdinsightDistrict?providerId={providerId} |
Get an EdInsight district based on ProviderId |
| GET api/getEdinsightRoster?userToken={userToken}&providerId={providerId} |
Get Edinsight roster result. |
Alerts
| API | Description |
|---|---|
| DELETE api/alerts/{alertId} |
No documentation available. |
| GET api/Alerts |
No documentation available. |
ResourceAssigneds
| API | Description |
|---|---|
| DELETE {assignedId} |
Delete assigned user resource |
| GET api/resourceAssigneds/isResourceAlreadySent/{resourceId}/{studentId}/{sentByUserId} |
No documentation available. |
| POST api/ResourceAssigneds |
Assign a particular resource to user on Send Resource feature |
| GET api/ResourceAssigneds?page={page}&perPage={perPage}&sortOrder={sortOrder}&searchKeyword={searchKeyword}&studentgroupId={studentgroupId} |
Get all assigned resources |
| GET api/ResourceAssigneds?userId={userId} |
Get all assigned resources |
| GET api/ResourceAssigneds?accountId={accountId}&userId={userId} |
Get All assigned resources for a student based on the account. |
| PUT api/ResourceAssigneds |
Update assigned resource to update student viewed related data |
| GET api/ResourceAssigneds?resourceId={resourceId}&studentId={studentId}&sentByUserId={sentByUserId} |
No documentation available. |
Activities
| API | Description |
|---|---|
| GET api/missionControl/activities/{id} |
No documentation available. |
Team
| API | Description |
|---|---|
| POST api/teams |
Creates a team |
| PUT api/teams/{id} |
No documentation available. |
AccountEmailPatterns
| API | Description |
|---|---|
| GET api/AccountEmailPatterns?accountId={accountId} |
No documentation available. |
| POST api/AccountEmailPatterns |
No documentation available. |
| DELETE api/AccountEmailPatterns/{accountEmailPatternId} |
No documentation available. |
AssessmentItems
| API | Description |
|---|---|
| GET api/missionControl/AssessmentItems/{id} |
No documentation available. |
| GET api/missionControl/AssessmentItems?ids[0]={ids[0]}&ids[1]={ids[1]} |
No documentation available. |
Accounts
StandardTypes
| API | Description |
|---|---|
| GET api/StandardTypes |
Get all Standard Types |
| GET api/StandardTypes/{standardTypeId} |
Get a Standard Type |
TestTypes
The controller that will handle requests related to Test Type
| API | Description |
|---|---|
| GET api/TestTypes/{TestTypeId} |
Get Test Type based on Test Type Id |
| GET api/TestTypes |
Get all Test Types |
Administrations
TeamColor
| API | Description |
|---|---|
| GET api/teamColors |
Gets all team colors |
Quiz
Subjects
The controller that will handle requests related to Subjects
| API | Description |
|---|---|
| GET api/subjects/{id} |
No documentation available. |
| GET api/Subjects |
Get all subjects |
Reporting
| API | Description |
|---|---|
| GET api/report/studentStandardMastery?userId={userId} |
No documentation available. |
| GET api/report/studentStandardMastery?accountId={accountId} |
No documentation available. |
| GET api/ReportingCategories |
No documentation available. |
| GET api/ReportingCategories?accountId={accountId} |
No documentation available. |
StudentGroups
LatestActivityParentResources
| API | Description |
|---|---|
| GET api/LatestActivityParentResources?parentUserId={parentUserId}&studentUserId={studentUserId} |
Get teacher resource lastest activities |
Questions
The controller that will handle requests related to Questions
| API | Description |
|---|---|
| GET api/questions/{questionId} |
Get Question by Id |
| GET api/answerOptions/{answerId} |
Get Answer Option by Id TODO: Move this to an AnswerOptionController |
| GET api/questions?passageId={passageId}&standardId={standardId} |
Gets questions for either a passage or based on an comma delimited list of standardIds TODO: There are sooooo many better ways to do this. Please look into this and fix it. Should probably be two routes |
| GET api/questions/getEveryQuestion |
Get's every question from the database TODO: I don't think this is used. Please ensure this is correct then remove this method. |
| GET api/questions/isExist/{questionId} |
Check whether the question exist or not |
| POST api/Questions?isProductionServer={isProductionServer} |
Copy's a question from the content portal, to this api instance's database. |
Students
LatestActivityTeacherResource
| API | Description |
|---|---|
| GET api/LatestActivityTeacherResources |
Get teacher resource lastest activities |
Purchase
| API | Description |
|---|---|
| GET api/subscription/details?teacherEmail={teacherEmail} |
No documentation available. |
| POST api/subscribe |
No documentation available. |
| GET api/subscriptions?AccountTypeId={AccountTypeId} |
No documentation available. |
| GET api/subscription?AccountId={AccountId} |
No documentation available. |
| GET api/subscription?teacherEmail={teacherEmail} |
No documentation available. |
| POST api/subscription/validate |
No documentation available. |
ClassLinkedResources
| API | Description |
|---|---|
| GET api/classLinkedResources |
No documentation available. |
| GET api/classLinkedResources/{classLinkedResourceId} |
No documentation available. |
| GET api/classLinkedResources?classResourceFolderId={classResourceFolderId} |
No documentation available. |
| DELETE api/classLinkedResources/{classLinkedResourceId} |
No documentation available. |
| POST api/classLinkedResources |
No documentation available. |
| PUT api/classLinkedResources/{classLinkedResourceId} |
No documentation available. |
Notifications
| API | Description |
|---|---|
| GET api/notifications |
No documentation available. |
| DELETE api/notifications/{id} |
No documentation available. |
AvatarFaces
This AvatarFacesController is used for managing avatars.
| API | Description |
|---|---|
| GET api/avatarFaces |
No documentation available. |
LearningStyles
| API | Description |
|---|---|
| GET api/learningStyles |
No documentation available. |
ResourceRecommendeds
| API | Description |
|---|---|
| DELETE api/ResourceRecommended/{recommendedResourceId} |
Delete recommended resource |
| GET api/ResourceRecommendeds?includeSta={includeSta} |
Get all recommended resources by user id |
| POST api/ResourceRecommendeds |
Create a recommended resource |
| PUT api/ResourceRecommendeds |
Update a recommended resource |
TestQuestions
The controller that will handle requests to the end point "api/testquestions". Cannot be inherited.
| API | Description |
|---|---|
| GET api/testquestions/{testQuestionId} |
Gets a by Id. |
| GET api/testquestions?testId={testId} |
Gets a list of filtered by the testId provided. |
| GET api/testquestions?studentTestId={studentTestId} |
Gets a list of filtered by the testAdministraitonId provided. |
| GET api/testquestions?administrationId={administrationId} |
Gets a list of filtered by an administrationId. |
| POST api/testquestions |
Add question to test |
| PUT api/testquestions/{testQuestionId} |
Updates a . |
| DELETE api/testquestions/{testQuestionId} |
Deletes a test question by id. |
StudentSecondPartAnswer
| API | Description |
|---|---|
| POST api/StudentSecondPartAnswers |
Create a new student answer |
| PUT {studentSecondPartAnswer} |
Update a student answer |
| GET {studentAnswerId} |
Update a student answer |
| DELETE api/StudentSecondPartAnswers/{studentAnswerId} |
No documentation available. |
Aliens
| API | Description |
|---|---|
| GET api/missionControl/aliens/{id} |
No documentation available. |
| GET api/missionControl/aliens/{id}/facts |
No documentation available. |
Standards
The controller that will handle requests related to Standards
| API | Description |
|---|---|
| GET api/standards |
Get all standards filtered by the teachers standard type id |
| GET api/standards/{standardId} |
Gets a standard by its id |
| GET api/standards?teacherUserId={teacherUserId} |
list out standards that the teacher has tested along with the number of questions tested from that standard |
StudentTrophies
This TrophyCategoriesController is used for managing trophies.
| API | Description |
|---|---|
| GET api/studentTrophies |
Get all Student Trophies for a student |
| GET api/studentTrophies?userId={userId} |
No documentation available. |
| PUT api/studentTrophies/{studentTrophyId} |
No documentation available. |
| POST api/studentTrophies |
No documentation available. |
ResourceBookmarks
| API | Description |
|---|---|
| DELETE api/ResourceBookmarks/{bookmarkId} |
Delete user resource bookmark |
| POST api/ResourceBookmarks |
Create user resource bookmark |
| GET api/ResourceBookmarks?page={page} |
Get all bookmarks for the current loggined user |
ClassLinkedResourceStudentNotifies
| API | Description |
|---|---|
| POST api/classLinkedResourceStudentNotifies |
No documentation available. |
| PUT api/classLinkedResourceStudentNotifies/{classLinkedResourceStudentNotifyId} |
No documentation available. |
| GET api/classLinkedResourceStudentNotifies |
No documentation available. |
| DELETE api/classLinkedResourceStudentNotifies/{classLinkedResourceStudentNotifyId} |
No documentation available. |
| GET api/classLinkedResourceStudentNotifies/isLinkedResourceAlreadySent/{classLinkedResourceId}/{studentUserId} |
No documentation available. |
| GET api/classLinkedResourceStudentNotifies?classLinkedResourceId={classLinkedResourceId}&studentUserId={studentUserId} |
No documentation available. |
TestApprovedResources
This TestApprovedResources controller is used for pre-approved resources.
| API | Description |
|---|---|
| GET api/testApprovedResources?testId={testId} |
No documentation available. |
| GET api/testApprovedResources?testId={testId}&userId={userId} |
No documentation available. |
| GET api/testApprovedResources |
No documentation available. |
| POST api/testApprovedResources |
No documentation available. |
| PUT api/testApprovedResources/{testApprovedResourceId} |
No documentation available. |
| DELETE api/testApprovedResources/{testApprovedResourceId} |
No documentation available. |
TrophyCategories
This TrophyCategoriesController is used for managing trophies.
| API | Description |
|---|---|
| GET api/trophyCategories |
Get all Trophy Categories |
| GET api/trophyCategories?userId={userId}&fromDate={fromDate}&toDate={toDate}&filterType={filterType} |
Get all Trophy Categories |
Missions
| API | Description |
|---|---|
| GET api/missionControl/missions/{id} |
No documentation available. |
| GET api/missionControl/missions/{id}/standards |
No documentation available. |
| GET api/missionControl/missions/{id}/UserSentMissions |
No documentation available. |
ClassResourceStudentNotifies
| API | Description |
|---|---|
| POST api/classResourceStudentNotifies |
No documentation available. |
| PUT api/classResourceStudentNotifies/{ClassResourceStudentNotifyId} |
No documentation available. |
| GET api/classResourceStudentNotifies |
No documentation available. |
| DELETE api/classResourceStudentNotifies/{classResourceStudentNotifyId} |
No documentation available. |
| GET api/classResourceStudentNotifies/isClassResourceAlreadySent/{classResourceId}/{studentUserId} |
No documentation available. |
| GET api/classResourceStudentNotifies?classResourceId={classResourceId}&studentUserId={studentUserId} |
No documentation available. |
ClassResources
| API | Description |
|---|---|
| GET api/classResources/{classResourceId} |
No documentation available. |
| GET api/classResources?classResourceFolderId={classResourceFolderId} |
No documentation available. |
| GET api/classResources |
No documentation available. |
| DELETE api/classResources/{classResourceId} |
No documentation available. |
| POST api/classResources |
No documentation available. |
| POST api/classResources/UploadClassResource?classResourceId={classResourceId} |
No documentation available. |
| PUT api/classResources/{classResourceId} |
No documentation available. |
| GET api/classResources/DownloadFile?fileName={fileName} |
Download file |
Resources
| API | Description |
|---|---|
| GET api/resources/{resourceId} |
Get Resource details by Id |
| GET api/resources/{userId} |
Get all Resource under a user |
| GET api/resources?userId={userId}&fromDate={fromDate}&toDate={toDate}&filterType={filterType} |
Get all Resource under a teacher |
| GET api/resources?gradeLevelId={gradeLevelId}&subjectId={subjectId}&targetId={targetId}&reportingCategoryId={reportingCategoryId}&assessmentAnchorId={assessmentAnchorId}&eligibleContents={eligibleContents} |
Get all Resources |
| GET api/resources?testId={testId} |
No documentation available. |
| POST api/resources/CopyResource/{isProductionServer} |
Copy Resource from TLM content to classroomresponder database |
Teachers
RosterCreationErrors
| API | Description |
|---|---|
| GET api/rosterCreationErrors/{id} |
Get roster creation errors based on the id |
| DELETE api/rosterCreationErrors/{id} |
Delete roster creation errors based on the id |
| GET api/RosterCreationErrors?userId={userId} |
Get roster creation errors based on the creator |
SchoolYear
| API | Description |
|---|---|
| GET api/schoolyears |
No documentation available. |
MissionLeaderboards
| API | Description |
|---|---|
| GET api/missionLeaderboards |
No documentation available. |
ClassLibraryFolders
| API | Description |
|---|---|
| GET api/classLibraryFolders |
No documentation available. |
| GET api/classLibraryFolders?classResourceFolderId={classResourceFolderId} |
No documentation available. |
| GET api/classLibraryFolders/{classResourceFolderId} |
No documentation available. |
| DELETE api/classLibraryFolders/{classResourceFolderId} |
No documentation available. |
| POST api/classLibraryFolders |
No documentation available. |
| PUT api/classLibraryFolders/{classResourceFolderId} |
No documentation available. |
| DELETE api/classLibraryFolders/DeleteFoldersAndResources |
No documentation available. |
ResourceUserReviews
| API | Description |
|---|---|
| GET api/resourceUserReviews/{resourceId} |
Get user reviewes by Resource Id |
| PUT api/resourceUserReviews/{resourceId} |
No documentation available. |
| DELETE api/resourceUserReviews/{reviewId} |
Get user reviewes by Resource Id |
| GET api/ResourceUserReviews |
Get user reviewes by Resource Id |
| POST api/ResourceUserReviews |
Get user reviewes by Resource Id |
StudentTestAdministrations
Handles requests for /api/studenttestadministrations
| API | Description |
|---|---|
| GET api/studentTestAdministrations?testId={testId} |
Get request to get all the test administrations for a given test |
| GET api/studentTestAdministrations |
No documentation available. |
| GET api/studentTestAdministrations?administrationId={administrationId} |
No documentation available. |
| GET api/studentTestAdministrations?studentUserId={studentUserId}&isOpen={isOpen} |
Get all student test administrations for a student. Response is filtered based on the isOpen parameter. Only pages the response when it is looking at closed administrations. TODO: REFACTOR. The response should either always be paged or never, not either or. |
| GET api/studentTestAdministrations?isOpen={isOpen} |
Get all student test administrations for the currently logged in user. Response is filtered based on the isOpen parameter. Only pages the response when it is looking at closed administrations. TODO: REFACTOR. The response should either always be paged or never, not either or. |
| GET api/studentTestAdministrations?userId={userId} |
Gets all student test administrations for the student specified. |
| GET api/studentTestAdministrations?isOpen={isOpen}&userId={userId} |
Get all open student test administrations for a student |
| GET api/studentTestAdministrations?studentUserId={studentUserId}&fromDate={fromDate}&toDate={toDate}&filterType={filterType} |
Gets all the finished student test administrations for a given student. |
| GET api/studentTestAdministrations?accountId={accountId}&userId={userId} |
Get All quizzes for a student based on the account. TODO: REFACTOR. 90% sure this is a dead call. Make sure before removing. |
| POST api/studentTestAdministrations |
Creates a student test administration record. |
| GET api/studentTestAdministrations/{studentTestId} |
Get student test administration by id |
| PUT api/studentTestAdministrations/{studentTestId} |
Update student test administration |
| GET api/studentTestAdministrations/getAdministrationId/{studentTestId} |
Gets an administration id from a student test id |
| DELETE api/studentTestAdministrations/{studentTestId} |
Deletes a student test administration |
KeyValue
| API | Description |
|---|---|
| GET api/keyValues?accountId={accountId}&userId={userId} |
GetAdminDashboardDetails |
| GET api/teacherLeaderboards?accountId={accountId}&fromDate={fromDate}&toDate={toDate}&filterType={filterType} | |
| GET api/keyValues?accountId={accountId} |
GetQuickStatsDetails |
| GET api/usageTrackers?accountId={accountId}&fromDate={fromDate}&toDate={toDate}&filterType={filterType}&userRole={userRole} |
No documentation available. |
| GET api/userTrackers?userId={userId}&fromDate={fromDate}&toDate={toDate}&filterType={filterType} |
No documentation available. |
Planets
| API | Description |
|---|---|
| GET api/missionControl/planets |
No documentation available. |
| GET api/missionControl/planets/{id} |
No documentation available. |
| GET api/missionControl/planets/{id}/missions |
No documentation available. |
| GET api/missionControl/planets/{id}/standards |
No documentation available. |
| GET api/missionControl/planets/{id}/facts |
No documentation available. |
InterestAreas
| API | Description |
|---|---|
| GET api/interestAreas |
No documentation available. |
Tutors
| API | Description |
|---|---|
| POST api/tutors |
No documentation available. |
| GET api/tutors/{id} |
No documentation available. |
Trophies
| API | Description |
|---|---|
| GET api/trophies/{trophyId} |
No documentation available. |
| GET api/trophies |
No documentation available. |
Passages
| API | Description |
|---|---|
| GET api/passages?gradeLevelId={gradeLevelId}&subjectId={subjectId} |
Gets passages filtered by grade level and subject. |
| GET api/passages/{passageId} |
Gets a single passage by id. |
| GET api/passages?studentTestId={studentTestId} |
Gets a single passage based on a test administration. |
| POST api/Passages?isDevelopmentServer={isDevelopmentServer} |
Creates a new passage. |
StudentMissions
| API | Description |
|---|---|
| GET api/studentMissions?onlyPointEligible={onlyPointEligible} |
No documentation available. |
| GET api/studentMissions/{id} |
No documentation available. |
| GET api/studentMissions?studentId={studentId}&onlyPointEligible={onlyPointEligible}&include={include} |
No documentation available. |
| POST api/studentMissions |
No documentation available. |
| POST api/studentMissions/{id}/start |
No documentation available. |
Galaxies
| API | Description |
|---|---|
| GET api/missionControl/galaxies |
No documentation available. |
| GET api/missionControl/galaxies/{id} |
No documentation available. |
| GET api/missionControl/galaxies/{id}/planets |
No documentation available. |
ResourceStudentRatings
| API | Description |
|---|---|
| DELETE api/resourceStudentRatings/{ratingId} |
Delete student resource rating |
| PUT api/resourceStudentRatings/{ratingId} |
Update student resource rating |
| POST api/ResourceStudentRatings |
Add student resource rating |
| GET api/ResourceStudentRatings?resourceId={resourceId} |
Get all student ratings based on resource id |
UserSentMissions
| API | Description |
|---|---|
| POST api/userSentMissions/bulk |
No documentation available. |
| POST api/userSentMissions |
No documentation available. |
| PUT api/userSentMissions/{id} |
No documentation available. |
| GET api/userSentMissions?missionId={missionId}&include={include} |
No documentation available. |
| GET api/userSentMissions?teacherId={teacherId}&include={include} |
No documentation available. |
| GET api/userSentMissions?studentId={studentId} |
No documentation available. |
| GET api/userSentMissions/{id} |
No documentation available. |
StudentMissionAnswers
| API | Description |
|---|---|
| GET api/StudentMissionAnswers?studentMissionId={studentMissionId} |
No documentation available. |
| GET api/StudentMissionAnswers?missionId={missionId}&onlyPointEligible={onlyPointEligible} |
No documentation available. |
| POST api/StudentMissionAnswers |
No documentation available. |
StudentAnswer
This StudentAnswerController is used for manage Student Answers.
| API | Description |
|---|---|
| GET api/StudentAnswers/Question/{questionId} |
Get all student answer details based on questionId (Table: StudentTestQuestionAnswer). |
| POST api/studentAnswers |
Create a new student answer |
| PUT api/StudentAnswers/{studentAnswerId} |
Update a student answer |
| GET api/StudentAnswers/{studentAnswerId} |
Update a student answer |
TestResult
The controller that will handle requests related to Test Result Statistics
| API | Description |
|---|---|
| GET api/testsummary/{administrationId} |
Get student test result summary based on administration id |
| GET api/testresult/{administrationId} |
Get test result informations for a student controlled test w.r.t. administration |
| GET api/testresult/administration/{administrationId}/question/{questionId} |
Get test result informations for a teacher controlled test w.r.t. question |
| GET api/statistics/student/{administrationId} |
Get student vice performance break down statistics for an administration |
| GET api/statistics/question/{administrationId} |
Get question vice performance break down statistics for an administration |
| GET api/statistics/standard/{administrationId} |
Get standard vice performance break down statistics for an administration |
Tips
| API | Description |
|---|---|
| DELETE api/tips/{tipId} |
No documentation available. |
| POST api/userTips |
No documentation available. |
| GET api/Tips |
No documentation available. |
AccountSubscriptionLinks
| API | Description |
|---|---|
| GET api/AccountSubscriptionLinks?accountId={accountId} |
No documentation available. |
Survey
| API | Description |
|---|---|
| GET api/SurveyReferrals |
No documentation available. |
| GET api/SurveyRoles |
No documentation available. |
| POST api/surveyAnswers |
No documentation available. |
| PUT api/surveyAnswers/{id} |
No documentation available. |
StudentSpaceships
| API | Description |
|---|---|
| GET api/missionControl/studentSpaceships?studentId={studentId} |
No documentation available. |
Parents
| API | Description |
|---|---|
| GET api/parents/{userId} |
No documentation available. |
| DELETE api/parents/removeStudent/{userId} |
No documentation available. |
| PUT api/parents/{userId} |
No documentation available. |
| GET api/Parents?code={code} |
Get parent based on the code |
| GET api/Parents?parentUserId={parentUserId}&studentUserId={studentUserId} |
Link parent to a student |
LatestActivityTeacherQuiz
| API | Description |
|---|---|
| GET api/LatestActivityTeacherQuizzes |
Get teacher quiz lastest activities |
Grades
| API | Description |
|---|---|
| GET api/Grades?gradeType={gradeType} | |
| GET api/Grades |
No documentation available. |
| GET api/Grades?accountId={accountId} |
States
| API | Description |
|---|---|
| GET api/States |
Get all states |
UserCreationErrors
The controller that will handle requests related to User Creation Errors.
| API | Description |
|---|---|
| PUT api/UserCreationErrors |
Update user creation errors |
| GET api/UserCreationErrors?userRole={userRole} |
Get user creation errors based on the creator |
| DELETE api/UserCreationErrors/{id} |
Delete user creation errors based on the id |
LatestActivityStudentResources
| API | Description |
|---|---|
| GET api/LatestActivityStudentResources |
Get student resource lastest activities |