bksbLIVE2 API - Documentation

Gets courses information from bksbLIVE 2.

• GET api/courses/allCourses

  Get all available courses on bksbLIVE2 system.

  Test API
• GET api/courses/licensedCourses

  Get all courses licensed to your organisation.

  Test API
• GET api/courses/course?courseSubject={courseSubject}

  Get a course by course subject.

  Test API
• GET api/courses/courseLevel?courseSubject={courseSubject}

  Get a course by course level.

  Test API

Gets users information from bksbLIVE 2.

• GET api/users/isUsernameExists?username={username}

  Check if a username already exists. returns true if already exists, else returns false.

  Test API
• POST api/users/createUser

  Create a new user.

  Test API
• GET api/users/search?userSearchType={userSearchType}&page={page}&recordsPerPage={recordsPerPage}&query={query}

  Search users.

  Test API
• GET api/users/user/{userId}/getUsername

  Get a username by id.

  Test API
• GET api/users/user/getUserId?username={username}

  Get a user id by username.

  Test API
• GET api/users/user/{userId}

  Get a user by id.

  Test API
• GET api/users/user/{userId}/getAutoLoginLink

  Get auto login link for a user.

  Test API
• GET api/users/user/getAutoLoginLink?username={username}

  Get auto login link for a user using username.

  Test API
• GET api/users/user/{userId}/getCourses

  Get user courses.

  Test API
• GET api/users/user/{userId}/whatToDoNext?courseSubject={courseSubject}

  Get what to do next link and details.

  Test API
• GET api/users/user/{userId}/getCourseSummary?courseSubject={courseSubject}

  Get user course summary (working level and working module set only).

  Test API
• GET api/users/user/{userId}/getCourseDetailedSummary?courseSubject={courseSubject}

  Get user course detailed summary.

  Test API
• POST api/users/user/{userId}/enrolCourse?courseSubject={courseSubject}

  Enrol a user on a course.

  Test API
• DELETE api/users/user/{userId}/removeCourse?courseSubject={courseSubject}

  Remove a user from a course.

  Test API
• GET api/users/user/{userId}/getGroups

  List of groups user is member of.

  Test API
• POST api/users/user/{userId}/addAsMemberOnUserGroup?userGroupId={userGroupId}

  Add user as a group member on a user group.

  Test API
• DELETE api/users/user/{userId}/removeAsMemberFromUserGroup?userGroupId={userGroupId}

  Remove user as a group member from a user group.

  Test API
• GET api/users/user/{userId}/getMyGroups

  List of a user's (staff member's) My Groups.

  Test API
• POST api/users/user/{userId}/addAsTutorOnGroup?userGroupId={userGroupId}

  Add user (staff member) as tutor on a user group.

  Test API
• DELETE api/users/user/{userId}/removeAsTutorFromGroup?userGroupId={userGroupId}

  Remove user (staff member) as tutor from a user group.

  Test API
• POST api/users/user/{userId}/changePassword?newPassword={newPassword}

  Change password.

  Test API
• POST api/users/user/{userId}/requestChangePassword

  User will be asked to change password on next login.

  Test API
• POST api/users/user/{userId}/removeRequestChangePassword

  This will remove any request to change password to the user. User will no longer require to change password.

  Test API
• POST api/users/user/{userId}/changeUsername?oldUsername={oldUsername}&newUsername={newUsername}

  Change username.

  Test API
• POST api/users/user/{userId}/updateDateOfBirth

  Update date of birth.

  Test API
• POST api/users/user/{userId}/updateEmail?email={email}

  Update email address.

  Test API
• POST api/users/user/{userId}/updateName?firstname={firstname}&lastname={lastname}

  Update firstname and lastname.

  Test API
• GET api/users/user/{userId}/getQuestionnaires

  Get user questionnaires.

  Test API
• POST api/users/user/{userId}/assignQuestionnaire?questionnaireGroupId={questionnaireGroupId}

  Assign a questionnaire group to the user.

  Test API
• POST api/users/user/{userId}/removeQuestionnaire?questionnaireGroupId={questionnaireGroupId}

  Remove a questionnaire group from user.

  Test API
• POST api/users/user/{userId}/changeAuthenticationMethod?authenticationMethod={authenticationMethod}&LDAPUsername={LDAPUsername}

  Update a users Authentication Method.

  Test API
• POST api/users/user/{userId}/enrolOntoAutoEnrolCourses

  Enrol user onto all auto enrol courses.

  Test API
• POST api/users/user/{userId}/enrolOntoAutoEnrolQuestionnaires

  Enrol user all auto enrol questionnaires.

  Test API
• GET api/users/user/getAllUserAditionalDetailsFields

  Return user additional details fields.

  Test API
• POST api/users/user/createNewAdditionalDetailFieldForUser?fieldName={fieldName}&fieldDataType={fieldDataType}&canUserEdit={canUserEdit}

  Create new additional details field for users.

  Test API
• GET api/users/user/{userId}/getCurrentWorkingLevelForCourse?courseSubject={courseSubject}

  Get current working level for a course

  Test API
• POST api/users/user/{userId}/archiveUser

  Archive a specific user.

  Test API
• POST api/users/user/{userId}/unarchiveUser

  Unarchive a specific user.

  Test API
• POST api/users/user/{userId}/overrideLevel?courseSubject={courseSubject}&courseLevelId={courseLevelId}

  Override a specific users level.

  Test API
• GET api/users/user/{userId}/sendLoginDetails

  Resends the login details for a specific user.

  Test API
• GET api/users/user/{userId}/getMergedUserId

  Retrieves the latest UserID for a merged user.

  Test API
• GET api/users/user/getV5Progress?userId={userId}&courseId={courseId}

  Retrieves reforms progress information for a user.

  Test API

Gets user groups information from bksbLIVE 2.

• GET api/userGroups/isGroupnameExists?groupname={groupname}

  Check if a user groupname already exists. returns true if already exists, else returns false.

  Test API
• POST api/userGroups/createUserGroup?groupname={groupname}&groupDescription={groupDescription}

  Create a new user group.

  Test API
• GET api/userGroups/search?page={page}&recordsPerPage={recordsPerPage}&query={query}

  Search user groups.

  Test API
• GET api/userGroups/userGroup/{userGroupId}

  Get a user group by id.

  Test API
• GET api/userGroups/userGroup/{userGroupId}/getMembers?page={page}&recordsPerPage={recordsPerPage}&query={query}

  Search group members.

  Test API
• POST api/userGroups/userGroup/{userGroupId}/addMember?userId={userId}

  Add user as a group member on a user group.

  Test API
• DELETE api/userGroups/userGroup/{userGroupId}/removeMember?userId={userId}

  Remove user as a group member from a user group.

  Test API
• GET api/userGroups/userGroup/{userGroupId}/getTutors

  Search group tutors.

  Test API
• POST api/userGroups/userGroup/{userGroupId}/addTutor?userId={userId}

  Add user (staff member) as tutor on a user group.

  Test API
• DELETE api/userGroups/userGroup/{userGroupId}/removeTutor?userId={userId}

  Remove user (staff member) as tutor from a user group.

  Test API
• POST api/userGroups/userGroup/{userGroupId}/updateGroupname?groupname={groupname}

  Update group name.

  Test API
• POST api/userGroups/userGroup/{userGroupId}/updateGroupDescription?groupDescription={groupDescription}

  Update group description.

  Test API
• GET api/userGroups/userGroup/getAllGroupAditionalDetailsFields

  Return user group additional details tags.

  Test API
• DELETE api/usersGroups/userGroup/{userGroupId}/removeGroup

  Remove a specific group, this will not remove the built-in 'Everyone' and 'ungrouped' groups.

  Test API
• POST api/users/user/createNewAdditionalDetailFieldForUserGroup?fieldName={fieldName}&fieldDataType={fieldDataType}

  Create new additional details field for groups.

  Test API

Results

• GET api/results/initialAssessment/{userId}/all?page={page}&recordsPerPage={recordsPerPage}

  Get initial assessment results for the user.

  Test API
• GET api/results/diagnosticAssessment/{userId}/all?page={page}&recordsPerPage={recordsPerPage}

  Get diagnostic assessment results for the user.

  Test API
• GET api/results/skillcheck/{userId}/all?page={page}&recordsPerPage={recordsPerPage}

  Get skillcheck results for the user.

  Test API
• GET api/results/resource/{userId}/all?page={page}&recordsPerPage={recordsPerPage}&resourceType={resourceType}

  Get resource results for the user.

  Test API
• GET api/results/revisionScenario/{userId}/all?page={page}&recordsPerPage={recordsPerPage}

  Get revision scenario results for the user.

  Test API
• GET api/results/test/{userId}/all?page={page}&recordsPerPage={recordsPerPage}

  Get test results for the user.

  Test API
• GET api/results/task/{userId}/all?page={page}&recordsPerPage={recordsPerPage}

  Get task results for the user.

  Test API
• GET api/results/questionnaire/{userId}/all?page={page}&recordsPerPage={recordsPerPage}

  Get questionnaire results for the user.

  Test API
• GET api/results/initialAssessment/{userId}/bySubject?page={page}&recordsPerPage={recordsPerPage}&courseSubject={courseSubject}

  Get initial assessment results for the user and course subject.

  Test API
• GET api/results/diagnosticAssessment/{userId}/bySubject?page={page}&recordsPerPage={recordsPerPage}&courseSubject={courseSubject}

  Get diagnostic assessment results for the user and course subject.

  Test API
• GET api/results/skillcheck/{userId}/bySubject?page={page}&recordsPerPage={recordsPerPage}&courseSubject={courseSubject}

  Get skillcheck results for the user and course subject.

  Test API
• GET api/results/resource/{userId}/bySubject?page={page}&recordsPerPage={recordsPerPage}&courseSubject={courseSubject}&resourceType={resourceType}

  Get resource results for the user and course subject.

  Test API
• GET api/results/revisionScenario/{userId}/bySubject?page={page}&recordsPerPage={recordsPerPage}&courseSubject={courseSubject}

  Get revision scenario results for the user and course subject.

  Test API
• GET api/results/test/{userId}/bySubject?page={page}&recordsPerPage={recordsPerPage}&courseSubject={courseSubject}

  Get test results for the user and course subject.

  Test API
• GET api/results/task/{userId}/bySubject?page={page}&recordsPerPage={recordsPerPage}&courseSubject={courseSubject}

  Get task results for the user and course subject.

  Test API
• GET api/results/questionnaire/{userId}/byQuestionnaireGroup?page={page}&recordsPerPage={recordsPerPage}&questionnaireGroupId={questionnaireGroupId}

  Get questionnaire results for the user and questionnaire group.

  Test API

Gets assessment and session information from bksbLIVE 2.

• GET api/assessmentSessions/getInitialAssessmentSessionsForCourse?courseSubject={courseSubject}&userId={userId}

  Get all initial assessment sessions for a course and user. List may include incomplete and voided sessions. Looking for Reformed/New Assessment data? Use api/assessmentSessions/getInitialAssessmentSessionsForCourseV5

  Test API
• GET api/assessmentSessions/getAssessmentSessionsForCourseV5?courseSubject={courseSubject}&userId={userId}

  Get all assessment sessions for a course and user. List may include incomplete and voided sessions. List will only include sessions created through the new Course View system (V5).

  Test API
• GET api/assessmentSessions/getDiagnosticAssessmentSessionsForCourse?courseSubject={courseSubject}&userId={userId}

  Get all diagnostic assessment sessions for a course (all levels) and user. List may include incomplete and voided sessions.

  Test API
• GET api/assessmentSessions/getDiagnosticAssessmentSessionsForCurrentWorkingLevel?courseSubject={courseSubject}&userId={userId}

  Get all diagnostic assessment sessions for a current working level and user. List may include incomplete and voided sessions.

  Test API
• GET api/assessmentSessions/getAssessmentSessionLinkForSession?sessionId={sessionId}&userId={userId}

  Get assessment session link using session.

  Test API
• GET api/assessmentSessions/getInitialAssessmentSessionLinkForCourse?courseSubject={courseSubject}&userId={userId}

  Get initial assessment session link for a course and user.

  Test API
• GET api/assessmentSessions/getDiagnosticAssessmentSessionLinkForCourse?courseSubject={courseSubject}&userId={userId}

  Get diagnostic assessment session link for a course and user. Please note: This will return assessment session for current working level on the course. It will throw a generic exception (please see API Generic Exception section) in case where working level is not set (i.e., initial assessment is not taken or working level is not set by a tutor.)

  Test API
• GET api/assessmentSessions/getEOAReportLinkForSession?sessionId={sessionId}&userId={userId}

  Get end of assessment (EOA) report link for a session.

  Test API
• GET api/assessmentSessions/getEOAReportDataForInitialAssessmentSession?sessionId={sessionId}&userId={userId}

  Get end of assessment (EOA) report data for an initial assessment session.

  Test API
• GET api/assessmentSessions/getEOAReportDataForDiagnosticAssessmentSession?sessionId={sessionId}&userId={userId}

  Get end of assessment (EOA) report data for an diagnostic assessment session.

  Test API
• GET api/assessmentSessions/GetEOAReportDataForAssessmentSessionV5?sessionId={sessionId}&userId={userId}

  Get end of assessment (EOA) report data for a V5 assessment session (Reformed content/new courses).

  Test API

Gets questionnaires information from bksbLIVE 2.

• GET api/questionnaires/allQuestionnaires

  Get all available questionnaires on bksbLIVE2 system.

  Test API
• GET api/questionnaires/licensedQuestionnaires

  Get all questionnaires licensed to your organisation.

  Test API
• GET api/questionnaires/questionnaire/{questionnaireGroupID}

  Get a questionnaire by questionnaire group id.

  Test API

This is test controller to check if your API access is configured correctly.

• GET api/test/test

  This should return true if your API access is configured correctly.

  Test API
• GET api/test/version

  This should return true if your API access is configured correctly.

  Test API