BlueLMSWS
The following operations are supported. For a formal definition, please review the Service Description.
-
AddBlock
Adds a new block -
AddBlockToCourse
Inserts a block spec. by a blockID into a course spec. by courseID -
AddClientRelatedBlock
Adds a new block -
AddClientRelatedCourse
Adds a new course -
AddClientRelatedCourseCollection
Add a new course collection with the given name, description and sort position, returns the ID of the created course collection -
AddClientRelatedCourseGroup
Add a new course group with the given name, description, sort position to the given course collection, returns the ID of the created course group -
AddComment
Adds a comment to a specified linkShare. -
AddCourse
Adds a new course -
AddCourseCollection
Add a new course collection with the given name, description and sort position, returns the ID of the created course collection -
AddCourseGroup
Add a new course group with the given name, description, sort position to the given course collection, returns the ID of the created course group -
AddCourseToCourseGroup
Inserts a course spec. by a courseID into a courseGroup spec. by courseGroupID -
AddCreditProfile
Adds a credit profile to a specified course -
AddFile
Adds a new File to the fileshare area.FileShareInfo.fileSize and FileShareInfo.dateSubmitted fields are not taken into account.clientID determined by FileShareInfo.submitterUserID -
AddLessonToBlock
Inserts a lesson spec. by a lessonID into a block spec. by blockID -
AddLessonToCourse
Inserts a lesson spec. by a lessonID into a course spec. by courseID -
AddLink
Adds a new Link to the linkshare area. LinkInfo.dateSubmitted and linkID fields are not taken into account -
AddNewBoard
Adds a new board to the discusson forum for the client specified by userID, and category specified by categoryID -
AddNewDiscussion
Adds a new discussion (topic or reply) to the discussion forum of the client specified by clientID -
AddOfflineCourse
Adds a new offline course -
AddRelatedFile
Adds a related file to an existing file spec. by updateToFileID -
AddUserToWaitingList
Adds user to classroom course waiting list -
ApplyEnrollmentCode
Applies the passed enrollment code for the user specified by the userIDToEnroll. -
BanUserFromDiscussion
Deletes a discussion from the discussion forum of the client specified by clientID -
CheckGroupEnrollment
Check user enrollment's uniquness for offline course -
CheckUserEnrollment
Check user enrollment's uniquness for offline course -
CheckWaitingList
Check waiting list item uniquness -
DeleteBlock
Deletes a block specified by its blockID -
DeleteBlockFromCourse
Removes a block spec. by a lessonID into a course spec. by courseID -
DeleteBoard
Deletes a board from the discussion forum specified by boardID -
DeleteClientRelatedBlock
Deletes a block specified by its blockID -
DeleteClientRelatedCourse
Deletes a course specified by its courseID -
DeleteClientRelatedCourseCollection
Delete the given course collection -
DeleteClientRelatedCourseGroup
Delete the given course group -
DeleteClientRelatedLesson
Deletes a lesson specified by its lessonID -
DeleteCourse
Deletes a course specified by its courseID -
DeleteCourseCollection
Delete the given course collection -
DeleteCourseFromCollection
Removes the course spec. by courseID from the collection and also from the courseGroup -
DeleteCourseFromCourseGroup
Removes the course spec. by the courseID only from the courseGroup. The course will remain available in the courseCollection. -
DeleteCourseGroup
Delete the given course group -
DeleteDiscussion
Deletes a discussion from the discussion forum of the client specified by clientID -
DeleteFile
Removes a file from the fileshare area -
DeleteLesson
Deletes a lesson specified by its lessonID -
DeleteLessonFromBlock
Removes a lesson spec. by a lessonID from a course spec. by courseID -
DeleteLessonFromCourse
Removes a lesson spec. by a lessonID from a course spec. by courseID -
DeleteLink
Deletes a link specified by the linkID -
DeleteWaitingList
Delete the user user from the waiting list, specified by the waitingList parameter -
EditBlock
Updates an existing block spec. by blockID -
EditBoard
Updates an existing board in the discusson forum for the client specified by userID, and category specified by categoryID -
EditClientRelatedBlock
Updates an existing block spec. by blockID -
EditClientRelatedCourse
Updates an existing course specified by courseID -
EditClientRelatedCourseCollection
Edit the every field of the given course collection except the ID -
EditClientRelatedCourseGroup
Edit the every field of the given course group except the ID -
EditCourse
Updates an existing course spec. by courseID -
EditCourseCollection
Edit the every field of the given course collection except the ID -
EditCourseGroup
Edit the every field of the given course group except the ID -
EditDiscussion
Modifies the discussion(topic or reply) specified by discussionID. It modifies only the subject and message of the discussion. -
EditFileShare
Updates a file in the fileshare area. The FileShareInfo.path field is not taken into account, and FileShareInfo.submitterUserID must be the userID which makes the EditFileShare -
EditFileShareUpdate
Updates a file to be an update of an existing fileshare of which ID is passed in updateToFileID parameter.in the fileshare area. The FileShareInfo.path field is not taken into account, and FileShareInfo.submitterUserID must be the userID who takes the action. -
EditGroupEnrollment
Modifies the given enrollment for the user group specified by the 'enrolledUserGroupID' parameter -
EditLink
Updates a link specified by the linkID. LinkInfo.dateSubmitted field is not taken into account -
EditOfflineCourse
Editds a new offline course -
EditUserEnrollment
Modifies the given enrollment for the given user specified by the 'enrolledUserID' parameter -
EditUserEnrollmentOffline
Edits an offline enrollment -
EnrollGroupOffline
Enrolls the user group specified by the UserGroupID field of EnrollmentOffline object into the given classroom course -
EnrollUser
Enrolls the user specified by the userIDToEnroll parameter into the given course -
EnrollUserFacilitated
Enrolls the user specified by the userID parameter into the given facilitated course, and section -
EnrollUserGroup
Enrolls the given user group specified by the userGroupIDToEnroll parameter into the given course -
EnrollUserGroupIntoCourseCollection
Enrolls the given user group into all the courses contained by the course collection -
EnrollUserGroupIntoCourseGroup
Enrolls the given user group into all the courses contained by the course group -
EnrollUserIntoCourseCollection
Enrolls the given user into all the courses contained by the course collection -
EnrollUserIntoCourseGroup
Enrolls the given user into all the courses contained by the course group -
EnrollUserIntoDemoCourses
Enroll user into the demo courses of the client which the user belongs to. The demo courses of which the user is already enrolled into are ignored. -
EnrollUserOffline
Enrolls the user specified by the userIDToEnroll parameter into the given course -
EvaluateQuestionResponse
Evaluates the response given by the user to the question and returns the result of the grading optionally will store the result, and user response in database. If storeResult is set to false the result will not be stored in the database allowing for just grading the question response without influencing the score of the assessment. -
EvaluateXmlQuestionResponse
Evaluates the response given by the user to the question and returns the result of the grading optionally will store the result, and user response in database. If storeResult is set to false the result will not be stored in the database allowing for just grading the question response without influencing the score of the assessment. -
GetAssessment
Returns the assessment with the given id for the given user. It also checks whether the user has reached or not the allowed maximum numbers of attempts. If the user reached the max number of attempts than the method returns the appropriate error message. -
GetAssessmentContainers
Returns a collection of <LessonID, AssessmentSectionID, SectionName> that represents the containers of the assessment. -
GetAssessmentID
Returns the ID of the assessment given its name. -
GetAssessmentScore
Returns the score of the assessment received by the user when the questions of the assessment were graded last time and stored in the database. -
GetAssessments
Returns the assessments of the client whose admin’s user name is passed as parameter. The admin needs at least read access rights for assessments. -
GetBlockLessons
Retrieves information – lessonID, lessonName - of lessons that belong to a specified Block -
GetBlocks
Retrieves information – blockID, blockName - of all of the lessons -
GetBoards
Retrieves information – boardID, boardName, description and category id - of all of the boards that belong to a client specified by userID -
GetCategories
Retrieves those categories which belong to the client determined by userID, and which suit to the given categoryType - GetCategoryAccess
-
GetClientRelatedBlocks
Retrieves information – blockID, blockName - of all of the lessons -
GetClientRelatedCourseCollections
Rerieves the course collections info -
GetClientRelatedCourseGroups
Rerieves the course collections info -
GetClientRelatedCourses
Retrieves information – courseID, courseName - of all of the courses -
GetClientRelatedLessons
Retrieves information – lessonID, lessonName - of all of the lessons -
GetComments
Retrieves the comments for a specified linkshare -
GetCourseBlocks
Retrieves information – blockID, blockName - of the blocks that belong to a specified Course -
GetCourseCatalog
Retrieves the course catalog of a client organization given the client organization’s administrator login name -
GetCourseCatalogs
Retrieves the course catalogs of the client the user belongs to. User must be administrator. -
GetCourseCollectionPurchaseLink
Retrieves the purchase link of a course collection. The method should be called just before opening the returned purchase link as it contains an authentication token which expires after 20 seconds. -
GetCourseCollections
Rerieves the course collections info -
GetCourseGroupPurchaseLink
Retrieves the purchase link of a course group. The method should be called just before opening the returned purchase link as it contains an authentication token which expires after 20 seconds. -
GetCourseGroups
Rerieves the course collections info -
GetCoursePurchaseLink
Retrieves the purchase link of a course. The method should be called just before opening the returned purchase link as it contains an authentication token which expires after 20 seconds. -
GetCourses
Retrieves information – courseID, courseName - of all of the courses -
GetDemoCourses
Retrieves the IDs of the demo courses of the client organization which the given user belongs to -
GetDiscussions
Retrieves information of all of the discussion boards of the client the specified user belongs to, given the user’s ID -
GetFacilitatedCourseSections
Gets the given facilitated course's sections. -
GetFacilitatedCourses
Gets the given user's client facilitated courses. -
GetFileShares
Retrieves the shared files that can be viewed by the given user -
GetLessonLaunchUrl
Assembles the Url that launches the given lesson. -
GetLessons
Retrieves information – lessonID, lessonName - of all of the lessons -
GetLinkShares
Retrieves the shared links that can be viewed by the given user -
GetOfflineCourseSchedule
Retrieves the schedule of all the unexpired offline course of a client given the ID of one of the administrator users. -
GetRelatedFileShares
Retrieves the shared related files that belong to the given file and can be viewed by the given user -
GetUserAssessmentScores
Retrieves the assessment scores, which are not contained by lesson. -
GetUserCourseProgress
Returns the course progress info for the given user and the given course -
GetUserCourses
Retrieves all the unexpired courses a given user is enrolled to and the unexpired courses the given user is enrolled to through user groups. -
GetUserEnrollments
Rerieves the enrollments info of the given user specified by the 'enrolledUserID' parameter -
GetUserEnrollmentsOffline
Rerieves the offline enrollments info of the given user specified by the 'enrolledUserID' parameter -
GetUserGroupEnrollments
Rerieves the enrollments info of the given user group specified by the 'enrolledUserGroupID' parameter -
GetUserGroupEnrollmentsOffline
Rerieves the offline enrollments info of the given user specified by the 'enrolledUserID' parameter -
GetUserGroupID
Retrieves the user group ID of the given user group of the client organization of which administrator’s login name is specified -
GetUserID
Retrieves the user ID of the given user of the client organization of which the administrator’s login name is specified -
GetUserLessonAssessmentScores
Retrieves the assessment scores of the users lesson. -
GetUserOfflineCourses
Retrieves all the unexpired offline courses a given user is enrolled to and the unexpired courses the given user is enrolled to through user groups. -
GetUserOnlineCourses
Retrieves all the unexpired online courses a given user is enrolled to and the unexpired courses the given user is enrolled to through user groups. -
GetUserResponse
Returns the response or responses of the user to the question which was stored in the database last time. -
ImportCourse
Creates a new course, adds it into a courseCollection spec.by courseCollectionID, adds new lessons and attaches them to the course just created -
ListUserAssessment
List assessments which are not assigend to lesson, and which have response(s) by the user. -
ListUserCourseLessonsAssessment
List users assessments which are assigend to lesson, and which have response(s) by the user. -
ListUserCourseLessonsByAssessment
List user instrucor lessons, which contains assessment(s). -
ListUserCoursesByAssessment
List user online courses, which contains assessment(s). -
RemoveUserGroupRestrictionFromFileShare
Removes restrictions of the user group spec. by restrictedUserGroupID on the shared file with ID spec. by fileID -
RemoveUserRestrictionFromFileShare
Removes restrictions of the user spec. by restrictedUserID on the shared file with ID spec. by fileID -
RequestEnrollment
Request an enrollment to the given course for the given user -
RestrictUserFileShare
Restricts the access rights of the user spec. by restrictedUserID on the shared file with ID spec. by fileID -
RestrictUserGroupFileShare
Restricts the access rights of the user group spec. by restrictedUserGroupID on the shared file with ID spec. by fileID -
SetDemoCourses
Sets the passed courses to be available as demo courses. Enrollments into demo courses extend up to the specified days starting from the moment a user is enrolled into the demo courses. -
UnenrollOfflineEnrollment
Unenrolls the given user specified by the userIDToUnenroll parameter from the given enrollment -
UnenrollUser
Unenrolls the given user specified by the userIDToUnenroll parameter from the given enrollment -
UnenrollUserFacilitated
Unenrolls the user specified by the userID parameter from the given facilitated course -
UnenrollUserGroup
Unenrolls the given user group specified by the 'userGroupIDToUnenroll' parameter from the given enrollment