442 lines
22 KiB
XML
442 lines
22 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>API.Student</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:OnlineAssessment.SwaggerConfigureOptions">
|
|
<summary>
|
|
Configures the Swagger generation options.
|
|
</summary>
|
|
<remarks>This allows API versioning to define a Swagger document per API version after the
|
|
<see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiVersionDescriptionProvider"/> service has been resolved from the service container.</remarks>
|
|
</member>
|
|
<member name="M:OnlineAssessment.SwaggerConfigureOptions.#ctor(Microsoft.AspNetCore.Mvc.ApiExplorer.IApiVersionDescriptionProvider)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OnlineAssessment.SwaggerConfigureOptions"/> class.
|
|
</summary>
|
|
<param name="provider">The <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiVersionDescriptionProvider">provider</see> used to generate Swagger documents.</param>
|
|
</member>
|
|
<member name="M:OnlineAssessment.SwaggerConfigureOptions.Configure(Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:OnlineAssessment.SwaggerDefaultValues">
|
|
<summary>
|
|
Represents the Swagger/Swashbuckle operation filter used to document the implicit API version parameter.
|
|
</summary>
|
|
<remarks>This <see cref="T:Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter"/> is only required due to bugs in the <see cref="T:Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator"/>.
|
|
Once they are fixed and published, this class can be removed.</remarks>
|
|
</member>
|
|
<member name="M:OnlineAssessment.SwaggerDefaultValues.Apply(Microsoft.OpenApi.Models.OpenApiOperation,Swashbuckle.AspNetCore.SwaggerGen.OperationFilterContext)">
|
|
<summary>
|
|
Applies the filter to the specified operation using the given context.
|
|
</summary>
|
|
<param name="operation">The operation to apply the filter to.</param>
|
|
<param name="context">The current operation filter context.</param>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.ExamAttemptsController.GetUpcomingExamsOfTheBatch(System.String,System.Int32,System.Int32,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
|
<summary>
|
|
Get all exams
|
|
</summary>
|
|
<param name="language"></param>
|
|
<param name="batch_id"></param>
|
|
<param name="subject_id"></param>
|
|
<param name="sortBy"></param>
|
|
<param name="sortOrder"></param>
|
|
<param name="pageNumber"></param>
|
|
<param name="pageSize"></param>
|
|
<response code="-4000">Invalid input</response>
|
|
<response code="-4010">Resource is not allowed</response>
|
|
<response code="-4040">No Data</response>
|
|
<response code="-1">Unknown error</response>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.ExamAttemptsController.GetLiveExams(System.String,System.Int32,System.Int32,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
|
<summary>
|
|
Get all live exams
|
|
</summary>
|
|
<param name="language"></param>
|
|
<param name="batch_id"></param>
|
|
<param name="subject_id"></param>
|
|
<param name="sortBy"></param>
|
|
<param name="sortOrder"></param>
|
|
<response code="-4000">Invalid input</response>
|
|
<response code="-4010">Resource is not allowed</response>
|
|
<response code="-4040">No Data</response>
|
|
<response code="-1">Unknown error</response>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.ExamAttemptsController.GetLiveAuthorExams(System.String,System.Int32,System.Int32,System.Int32,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
|
<summary>
|
|
Get all live exams by author (subject id = 0 means fullexam, -1 means all exam, other than that will return based on subject)
|
|
</summary>
|
|
<param name="language"></param>
|
|
<param name="batch_id"></param>
|
|
<param name="author_id"></param>
|
|
<param name="subject_id"></param>
|
|
<param name="sortBy"></param>
|
|
<param name="sortOrder"></param>
|
|
<response code="-4000">Invalid input</response>
|
|
<response code="-4010">Resource is not allowed</response>
|
|
<response code="-4040">No Data</response>
|
|
<response code="-1">Unknown error</response>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.ExamAttemptsController.GetAttemptedExams(System.String,System.Int32,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
|
<summary>
|
|
Get all attempted exams
|
|
</summary>
|
|
<param name="language"></param>
|
|
<param name="sortBy"></param>
|
|
<param name="sortOrder"></param>
|
|
<response code="-4000">Invalid input</response>
|
|
<response code="-4010">Resource is not allowed</response>
|
|
<response code="-4040">No Data</response>
|
|
<response code="-1">Unknown error</response>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.ExamAttemptsController.GetExamDetails(System.String,System.Int32)">
|
|
<summary>
|
|
This endpoint will return the details of the exam.
|
|
Error Conditions: Invalid Exam, Attempt limit Over, Unknown error
|
|
</summary>
|
|
<param name="exam_id"></param>
|
|
<param name="language"></param>
|
|
<response code="-4000">Invalid input</response>
|
|
<response code="-4010">Resource is not allowed</response>
|
|
<response code="-1">Unknown error</response>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.ExamAttemptsController.AddNewExamAttempt(System.String,System.Int32)">
|
|
<summary>
|
|
This endpoint will create a new attempt for the exam.
|
|
Error Conditions: Invalid Exam, Attempt limit Over, Unknown error
|
|
</summary>
|
|
<param name="exam_id"></param>
|
|
<param name="language"></param>
|
|
<response code="-4000">Invalid input</response>
|
|
<response code="-4010">Resource is not allowed</response>
|
|
<response code="-1">Unknown error</response>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.ExamAttemptsController.AttachBookmarkToExams(System.Int32,System.Int32,OnlineAssessment.Domain.ViewModels.ExamBookMarkStatus)">
|
|
<summary>
|
|
Attach Bookmark To Exams
|
|
</summary>
|
|
<param name="bookMarkStatus"></param>
|
|
<response code="-4000">Invalid input</response>
|
|
<response code="-4010">Resource is not allowed</response>
|
|
<response code="-1">Unknown error</response>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.ExamAttemptsController.GetAllExamAttempts(System.Nullable{System.Boolean},System.String,System.String)">
|
|
<summary>
|
|
This endpoint retrieves all attempts for the authenticated user.
|
|
</summary>
|
|
<param name="isActive"></param>
|
|
<param name="sortBy"></param>
|
|
<param name="sortOrder"></param>
|
|
<response code="-4040">No Data</response>
|
|
<response code="-1">Unknown error</response>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.ExamAttemptsController.EndExamAttempt(System.Int32)">
|
|
<summary>
|
|
This endpoint ends an attempt and return the status as Completed and cannot be started again
|
|
</summary>
|
|
<param name="exam_attempt_id"></param>
|
|
<response code="-4000">Invalid input</response>
|
|
<response code="-1">Unknown error</response>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.ExamAttemptsController.PauseExamAttempt(System.Int32)">
|
|
<summary>
|
|
This endpoint starts a paused attempt. This is for restarting the timer calculation incase of a paused attempt.
|
|
</summary>
|
|
<param name="attempt_id"></param>
|
|
<response code="-4000">Invalid input</response>
|
|
<response code="-4010">Resource is not allowed</response>
|
|
<response code="-1">Unknown error</response>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.ExamAttemptsController.GetExamAttemptQuestions(System.String,System.Int32)">
|
|
<summary>
|
|
This endpoint returns all questions for an attempt.
|
|
</summary>
|
|
<param name="language"></param>
|
|
<param name="attempt_id"></param>
|
|
<response code="-4000">Invalid input</response>
|
|
<response code="-4040">No data</response>
|
|
<response code="-1">Unknown error</response>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.ExamAttemptsController.HeartBeat(System.Int32)">
|
|
<summary>
|
|
This endpoint returns all questions for an attempt.
|
|
</summary>
|
|
<param name="attempt_id"></param>
|
|
<response code="-4010">Resource is not allowed</response>
|
|
<response code="-1">Unknown error</response>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.ExamAttemptsController.UpdateAnswer(System.Int32,OnlineAssessment.Domain.ViewModels.QuestionAnswerViewModel)">
|
|
<summary>
|
|
This endpoint will update the answer of the attempted question.
|
|
</summary>
|
|
<param name="attempt_id"></param>
|
|
<param name="responses"></param>
|
|
<response code="-4000">Invalid input</response>
|
|
<response code="-4010">Resource is not allowed</response>
|
|
<response code="-1">Unknown error</response>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.ExamAttemptsController.Report(System.String,System.Int32)">
|
|
<summary>
|
|
View detailed report of a user completed attempt.
|
|
</summary>
|
|
<param name="language"></param>
|
|
<param name="exam_attempt_id"></param>
|
|
<response code="-4000">Invalid input</response>
|
|
<response code="-4010">Resource is not allowed</response>
|
|
<response code="-1">Unknown error</response>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.PracticeAttemptsController.GetLivePractices(System.Int32,System.String,System.Int32,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
|
<summary>
|
|
Get all Practices
|
|
</summary>
|
|
<param name="language"></param>
|
|
<param name="sortBy"></param>
|
|
<param name="sortOrder"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.PracticeAttemptsController.GetLiveAuthorPractices(System.Int32,System.Int32,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
|
<summary>
|
|
Get all Practices
|
|
</summary>
|
|
<param name="sortBy"></param>
|
|
<param name="sortOrder"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.PracticeAttemptsController.GetRecentPractices(System.Int32,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
|
<summary>
|
|
Get recent attempted Practices
|
|
</summary>
|
|
<param name="language"></param>
|
|
<param name="sortBy"></param>
|
|
<param name="sortOrder"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.PracticeAttemptsController.CreateNewPracticeAttempt(System.String,System.Int32)">
|
|
<summary>
|
|
This endpoint will create a new attempt for the Practice.
|
|
Error Conditions: Invalid Exam, Attempt limit Over, Unknown error
|
|
</summary>
|
|
<param name="language"></param>
|
|
<param name="practice_id"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.PracticeAttemptsController.GetPracticeDetails(System.String,System.Int32)">
|
|
<summary>
|
|
This endpoint will return the details of the practice.
|
|
Error Conditions: Invalid Practice, Unknown error
|
|
</summary>
|
|
<param name="practice_id"></param>
|
|
<param name="language"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.PracticeAttemptsController.AttachBookmarkToPractices(System.Int32,System.Int32,OnlineAssessment.Domain.ViewModels.BookMarkStatus)">
|
|
<summary>
|
|
Attach Bookmark To Praactices
|
|
</summary>
|
|
<param name="bookMarkStatus"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.PracticeAttemptsController.GetPracticeAttemptRevision(System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
This endpoint returns all questions for an attempt.
|
|
</summary>
|
|
<param name="language"></param>
|
|
<param name="practice_id"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.PracticeAttemptsController.GetBatchPracticeCoverage(System.Int32)">
|
|
<summary>
|
|
This endpoint returns attempted practice stats.
|
|
</summary>
|
|
<param name="batch_id"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.PracticeAttemptsController.EndPracticeAttempt(System.Int32,OnlineAssessment.Domain.ViewModels.PracticeAttemptResultModel)">
|
|
<summary>
|
|
This endpoint saves the result of an attempt.
|
|
</summary>
|
|
<param name="attempt_id"></param>
|
|
<param name="report"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.PracticeAttemptsController.RaiseQuestionBug(System.Int32,OnlineAssessment.Domain.ViewModels.QuestionBugModel)">
|
|
<summary>
|
|
This endpoint raise bug in a question.
|
|
</summary>
|
|
<param name="attempt_id"></param>
|
|
<param name="bugDetails"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UserGroupsController.GetAllUserGroupsOfTheClass(System.Int32,System.String,System.String)">
|
|
<summary>
|
|
Get list of all User Groups of a class
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UserGroupsController.GetAllUserGroups(System.String,System.String)">
|
|
<summary>
|
|
Get list of all User Groups of the institute
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UserGroupsController.Get">
|
|
<summary>
|
|
Get the list of User Groups of a user
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UserGroupsController.Get(System.Int32)">
|
|
<summary>
|
|
Get the detail of a User Group
|
|
</summary>
|
|
<param name="user_group_id"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UserGroupsController.AddUserGroup(System.Int32,OnlineAssessment.Domain.ViewModels.UserGroupAddModel)">
|
|
<summary>
|
|
Add a new User Group
|
|
</summary>
|
|
<param name="class_id"></param>
|
|
<param name="usergroup"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UserGroupsController.UpdateUserGroupOfTheInstitute(System.Int32,OnlineAssessment.Domain.ViewModels.UserGroupEditModel)">
|
|
<summary>
|
|
Update a new User Group
|
|
</summary>
|
|
<param name="user_group_id"></param>
|
|
<param name="usergroup"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UserGroupsController.GetUsersOfUserGroup(System.Int32)">
|
|
<summary>
|
|
Get users of user group
|
|
</summary>
|
|
<param name="user_group_id"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UserGroupsController.DeleteUserGroup(System.Int32)">
|
|
<summary>
|
|
Get users of user group
|
|
</summary>
|
|
<param name="user_group_id"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UserGroupsController.AttachUsersToUserGroup(System.Int32,OnlineAssessment.Domain.ViewModels.UserIdList)">
|
|
<summary>
|
|
Attch users to the user group
|
|
</summary>
|
|
<param name="user_group_id"></param>
|
|
<param name="userIdList"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UserGroupsController.DetachUsersToUserGroup(System.Int32,OnlineAssessment.Domain.ViewModels.UserIdList)">
|
|
<summary>
|
|
Attch users to the user group
|
|
</summary>
|
|
<param name="user_group_id"></param>
|
|
<param name="userIdList"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UsersController.SignUp(OnlineAssessment.Domain.ViewModels.UserAddModel)">
|
|
<summary>
|
|
Create a new user
|
|
</summary>
|
|
<param name="user"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UsersController.SignIn">
|
|
<summary>
|
|
User Log in
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UsersController.UpdatePreference(System.String)">
|
|
<summary>
|
|
Update language
|
|
</summary>
|
|
<param name="language"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UsersController.UpdateMyDetails(OnlineAssessment.Domain.ViewModels.ProfileDetailView)">
|
|
<summary>
|
|
Update user details
|
|
</summary>
|
|
<param name="profileDetailView"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UsersController.GetMyDetails">
|
|
<summary>
|
|
Get user details
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UsersController.AttachUserGroup(System.Int32,OnlineAssessment.Domain.ViewModels.DefaultGroup)">
|
|
<summary>
|
|
Attch me to usergroup
|
|
</summary>
|
|
<param name="user_group_id"></param>
|
|
<param name="defaultGroup"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UsersController.DetachUserGroup(System.Int32)">
|
|
<summary>
|
|
Detach user group of a user
|
|
</summary>
|
|
<param name="user_group_id"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UsersController.GetTeacherOfTheInstitution(System.Int32,System.Int32,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
|
<summary>
|
|
Get the teachers of an institute
|
|
</summary>
|
|
<param name="batch_id"></param>
|
|
<param name="sortBy"></param>
|
|
<param name="sortOrder"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UsersController.GetAllPlans(System.String,System.String)">
|
|
<summary>
|
|
Get all Plans
|
|
</summary>
|
|
<param name="sortBy"></param>
|
|
<param name="sortOrder"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UsersController.GetPlanByCode(System.String)">
|
|
<summary>
|
|
Get all Plans
|
|
</summary>
|
|
<param name="plan_code"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UsersController.CreateOrder(System.String)">
|
|
<summary>
|
|
Create Order ID
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UsersController.VerifyPayment(OnlineAssessment.Domain.ViewModels.VerifyPaymentView)">
|
|
<summary>
|
|
Verify user Payment
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V1.Controllers.UsersController.CurrentSubscription">
|
|
<summary>
|
|
User Current Subscription
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:OnlineAssessment.V2.Controllers.BaseController`2.Get(System.Int32)">
|
|
<summary>
|
|
Get a specific record by id
|
|
</summary>
|
|
<param name="id"></param>
|
|
<returns></returns>
|
|
</member>
|
|
</members>
|
|
</doc>
|