CourseService

• getCourse
• getCoursesByIds
• searchForCourseIds
• searchForCourses
• createCourse
• updateCourse
• deleteCourse
• validateCourse
• getCourseFormatsByCourse
• getCourseActivitiesByCourseFormat
• getCourseLearningObjectivesByCourse
• getCourseStatements
• createCourseStatement
• updateCourseStatement
• deleteCourseStatement
• validateCourseStatement
• createNewCourseVersion
• setCurrentCourseVersion
• getCurrentVersion
• getVersions

• CourseInfo
• QueryByCriteria
• StatusInfo
• ValidationResultInfo
• FormatInfo
• ActivityInfo
• LoDisplayInfo
• StatementTreeViewInfo
• VersionDisplayInfo

Method	getCourse
Description	Retrieves a Course
Parameters	String	courseId	Unique Id of the Course. Maps to cluId
	ContextInfo	contextInfo	???
Return	CourseInfo		the created course
Errors	DoesNotExistException		Course does not exist
	InvalidParameterException		invalid course
	MissingParameterException		missing Course
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCoursesByIds
Description	Retrieves a list of courses by Ids
Parameters	StringList	courseIds	???
	ContextInfo	contextInfo	???
Return	CourseInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	searchForCourseIds
Description	Searches for courses based on the criteria and returns a list of Comment identifiers which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of Comment Ids
Errors	InvalidParameterException		invalid parameter
	MissingParameterException		criteria, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForCourses
Description	Searches for courses based on the criteria and returns a list of Comments which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CourseInfoList		list of Comment information
Errors	InvalidParameterException		invalid parameter
	MissingParameterException		criteria, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createCourse
Description	Creates a Course
Parameters	CourseInfo	courseInfo	courseInfo
	ContextInfo	contextInfo	???
Return	CourseInfo		the created course
Errors	DataValidationErrorException		One or more values invalid for this operation
	InvalidParameterException		invalid course
	MissingParameterException		missing Course
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		???

Back to Operations

Method	updateCourse
Description	Updates a Course.
Parameters	String	courseId	???
	CourseInfo	courseInfo	courseInfo
	ContextInfo	contextInfo	???
Return	CourseInfo		updated Course
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		course not found
	InvalidParameterException		invalid course
	MissingParameterException		missing course
	VersionMismatchException		The action was attempted on an out of date version.
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	UnsupportedActionException		???
	DependentObjectsExistException		???
	AlreadyExistsException		???
	CircularRelationshipException		???
	CircularReferenceException		???
	ReadOnlyException		???

Back to Operations

Method	deleteCourse
Description	Deletes a Course.
Parameters	String	courseId	identifier for Course.Maps to cluId
	ContextInfo	contextInfo	???
Return	StatusInfo		status of the operation (success or failure)
Errors	DoesNotExistException		Course does not exist
	InvalidParameterException		invalid courseId
	MissingParameterException		invalid courseId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		???
	DataValidationErrorException		???
	AlreadyExistsException		???
	UnsupportedActionException		???
	DependentObjectsExistException		???
	CircularRelationshipException		???
	CircularReferenceException		???
	ReadOnlyException		???

Back to Operations

Method	validateCourse
Description	Validates a course based on its dictionary
Parameters	String	validationType	identifier of the extent of validation
	CourseInfo	courseInfo	Course to be validated
	ContextInfo	contextInfo	???
Return	ValidationResultInfoList		results from performing the validation
Errors	DoesNotExistException		Course does not exist
	InvalidParameterException		invalid courseId
	MissingParameterException		invalid courseId
	OperationFailedException		unable to complete request

Back to Operations

Method	getCourseFormatsByCourse
Description	Retrieves the formats for a Course.
Parameters	String	courseId	Unique Id of the Course. Maps to cluId
	ContextInfo	contextInfo	???
Return	FormatInfoList		a list of format info Structures
Errors	DoesNotExistException		Course does not exist
	InvalidParameterException		invalid courseId
	MissingParameterException		invalid courseId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCourseActivitiesByCourseFormat
Description	Retrieves the Activities for a Course.
Parameters	String	formatId	Unique Id of the Format. Maps to cluId
	ContextInfo	contextInfo	???
Return	ActivityInfoList		a list of activity info Structures
Errors	DoesNotExistException		Format does not exist
	InvalidParameterException		invalid format
	MissingParameterException		missing Format
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCourseLearningObjectivesByCourse
Description	Retrieves the Learning Objectives for a Course.
Parameters	String	courseId	Unique Id of the Course. Maps to cluId
	ContextInfo	contextInfo	???
Return	LoDisplayInfoList		a list of LoDisplay info Structures
Errors	DoesNotExistException		Course does not exist
	InvalidParameterException		invalid courseId
	MissingParameterException		invalid courseId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCourseStatements
Description	Retrieves the Statements of a Course.
Parameters	String	courseId	Unique Id of the Course. Maps to cluId
	String	nlUsageTypeKey	Natural language usage type key (context)
	String	language	Translation language e.g en, es, gr
	ContextInfo	contextInfo	???
Return	StatementTreeViewInfoList		a list of Statement tree Structures
Errors	DoesNotExistException		Course does not exist
	InvalidParameterException		invalid courseId
	MissingParameterException		invalid courseId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createCourseStatement
Description	Creates the Statement for a Course.
Parameters	String	courseId	Unique Id of the Course. Maps to cluId
	StatementTreeViewInfo	statementTreeViewInfo	???
	ContextInfo	contextInfo	???
Return	StatementTreeViewInfo		created Statementree Structures
Errors	DoesNotExistException		Course does not exist
	InvalidParameterException		invalid courseId
	MissingParameterException		invalid courseId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	DataValidationErrorException		???

Back to Operations

Method	updateCourseStatement
Description	Updates the Statement for a Course.
Parameters	String	courseId	Unique Id of the Course. Maps to cluId
	String	statementId	???
	StatementTreeViewInfo	statementTreeViewInfo	???
	ContextInfo	contextInfo	???
Return	StatementTreeViewInfo		updated Statementree Structures
Errors	DoesNotExistException		Course does not exist
	InvalidParameterException		invalid courseId
	MissingParameterException		invalid courseId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	DataValidationErrorException		???
	VersionMismatchException		???

Back to Operations

Method	deleteCourseStatement
Description	Delete the Statement for a Course.
Parameters	String	courseId	Unique Id of the Course. Maps to cluId
	StatementTreeViewInfo	statementTreeViewInfo	???
	ContextInfo	contextInfo	???
Return	StatusInfo		status of the operation (success or failure)
Errors	DoesNotExistException		Course does not exist
	InvalidParameterException		invalid courseId
	MissingParameterException		invalid courseId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateCourseStatement
Description	Validates the Statement for a Course.
Parameters	String	courseId	Unique Id of the Course. Maps to cluId
	StatementTreeViewInfo	statementTreeViewInfo	???
	ContextInfo	contextInfo	???
Return	ValidationResultInfoList		results from performing the validation
Errors	InvalidParameterException		invalid courseId or stratement tree view Id
	MissingParameterException		invalid courseId or statement tree view Id
	OperationFailedException		unable to complete request
	PermissionDeniedException		???

Back to Operations

Method	createNewCourseVersion
Description	Creates a new Course version based on the current course
Parameters	String	courseId	identifier for the Course to be versioned
	String	versionComment	comment for the current version
	ContextInfo	contextInfo	???
Return	CourseInfo		the new versioned Course information
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		courseId not found
	InvalidParameterException		invalid courseId
	MissingParameterException		missing courseId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		The action was attempted on an out of date version
	ReadOnlyException		???

Back to Operations

Method	setCurrentCourseVersion
Description	Sets a specific version of the Course as current. The sequence number must be greater than the existing current Course version. This will truncate the current version's end date to the currentVersionStart param. If a Course exists which is set to become current in the future, that course's currentVersionStart and CurrentVersionEnd will be nullified. The currentVersionStart must be in the future to prevent changing historic data.
Parameters	String	courseVersionId	Version Specific Id of the Course
	Date	currentVersionStart	Date when this course becomes current. Must be in the future and be after the most current course's start date.
	ContextInfo	contextInfo	???
Return	StatusInfo		status of the operation
Errors	DoesNotExistException		courseVersionId not found
	InvalidParameterException		invalid courseVersionId, previousState, newState
	MissingParameterException		missing courseVersionId, previousState, newState
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	IllegalVersionSequencingException		a Course with higher sequence number from the one provided is marked current
	DataValidationErrorException		???

Back to Operations

Method	getCurrentVersion
Description	Retrieves current version associated with the objectId. ============== Deprecated ===============
Parameters	String	refObjectTypeURI	???
	String	refObjectId	???
	ContextInfo	contextInfo	???
Return	VersionDisplayInfo		current version
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getVersions
Description	??? ============== Deprecated ===============
Parameters	String	refObjectTypeURI	???
	String	refObjectId	???
	ContextInfo	contextInfo	???
Return	VersionDisplayInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations