CourseOfferingService

• rolloverCourseOffering
• updateCourseOfferingFromCanonical
• validateCourseOfferingFromCanonical
• generateRegistrationGroupsForFormatOffering
• getCourseOfferingDisplay
• getCourseOfferingDisplaysByIds
• getActivityOfferingDisplay
• getActivityOfferingDisplaysByIds
• getActivityOfferingDisplaysForCourseOffering
• getCourseOfferingType
• getCourseOfferingTypes
• getInstructorTypesForCourseOfferingType
• getCourseOffering
• getCourseOfferingsByIds
• getCourseOfferingsByCourse
• getCourseOfferingsByCourseAndTerm
• getCourseOfferingIdsByTerm
• getCourseOfferingIdsByTermAndSubjectArea
• getCourseOfferingsByTermAndInstructor
• getCourseOfferingIdsByTermAndUnitsContentOwner
• getCourseOfferingIdsByType
• getValidCanonicalCourseToCourseOfferingOptionKeys
• getValidRolloverOptionKeys
• createCourseOffering
• updateCourseOffering
• deleteCourseOffering
• deleteCourseOfferingCascaded
• validateCourseOffering
• getFormatOffering
• getFormatOfferingsByCourseOffering
• createFormatOffering
• updateFormatOffering
• validateFormatOffering
• deleteFormatOffering
• deleteFormatOfferingCascaded
• getActivityOfferingType
• getActivityOfferingTypes
• getActivityOfferingTypesForActivityType
• getInstructorTypesForActivityOfferingType
• getActivityOffering
• getActivityOfferingsByIds
• getActivityOfferingsByCourseOffering
• getActivityOfferingsByFormatOffering
• getActivityOfferingsWithoutClusterByFormatOffering
• getActivityOfferingsByFormatOfferingWithoutRegGroup
• createActivityOffering
• copyActivityOffering
• generateActivityOfferings
• updateActivityOffering
• deleteActivityOffering
• deleteActivityOfferingCascaded
• validateActivityOffering
• calculateInClassContactHoursForTerm
• calculateOutofClassContactHoursForTerm
• calculateTotalContactHoursForTerm
• getRegistrationGroup
• getRegistrationGroupsByIds
• getRegistrationGroupsForCourseOffering
• getRegistrationGroupsWithActivityOfferings
• getRegistrationGroupsByFormatOffering
• validateRegistrationGroup
• createRegistrationGroup
• updateRegistrationGroup
• deleteRegistrationGroup
• deleteRegistrationGroupsByFormatOffering
• deleteGeneratedRegistrationGroupsByFormatOffering
• deleteRegistrationGroupsForCluster
• verifyRegistrationGroup
• getActivityOfferingCluster
• getActivityOfferingClustersByFormatOffering
• validateActivityOfferingCluster
• createActivityOfferingCluster
• updateActivityOfferingCluster
• deleteActivityOfferingCluster
• verifyActivityOfferingClusterForGeneration
• generateRegistrationGroupsForCluster
• getSeatPoolDefinition
• getSeatPoolDefinitionsForActivityOffering
• createSeatPoolDefinition
• updateSeatPoolDefinition
• validateSeatPoolDefinition
• deleteSeatPoolDefinition
• addSeatPoolDefinitionToActivityOffering
• removeSeatPoolDefinitionFromActivityOffering
• searchForCourseOfferings
• searchForCourseOfferingIds
• searchForActivityOfferings
• searchForActivityOfferingIds
• searchForRegistrationGroups
• searchForRegistrationGroupIds
• searchForSeatpoolDefinitions
• searchForSeatpoolDefinitionIds

• CourseOfferingInfo
• ValidationResultInfo
• RegistrationGroupInfo
• CourseOfferingDisplayInfo
• ActivityOfferingDisplayInfo
• TypeInfo
• ContextInfo
• StatusInfo
• FormatOfferingInfo
• ActivityOfferingInfo
• ActivityOfferingClusterInfo
• SeatPoolDefinitionInfo
• QueryByCriteria

Method	rolloverCourseOffering
Description	???
Parameters	String	sourceCoId	???
	String	targetTermId	???
	StringList	optionKeys	???
	ContextInfo	context	???
Return	CourseOfferingInfo		???
Errors	AlreadyExistsException		???
	DataValidationErrorException		???
	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???
	ReadOnlyException		???

Back to Operations

Method	updateCourseOfferingFromCanonical
Description	???
Parameters	String	courseOfferingId	???
	StringList	optionKeys	???
	ContextInfo	context	???
Return	CourseOfferingInfo		???
Errors	DataValidationErrorException		???
	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???
	VersionMismatchException		???

Back to Operations

Method	validateCourseOfferingFromCanonical
Description	???
Parameters	CourseOfferingInfo	courseOfferingInfo	???
	StringList	optionKeys	???
	ContextInfo	context	???
Return	ValidationResultInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???

Back to Operations

Method	generateRegistrationGroupsForFormatOffering
Description	Generate a list of unconstrained registration groups for the formatOffering given. Pre conditions are that there are no existing generated registration groups (i.e. that the
Parameters	String	formatOfferingId	The format offering identifier to generate registration groups for.
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	RegistrationGroupInfoList		The list of all generated registration groups for the format offering given.
Errors	DoesNotExistException		The formatOfferingId does not refer to an existing FormatOffering.
	InvalidParameterException		The formatOfferingId or context is invalid.
	MissingParameterException		the formatOfferingId or context is missing.
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	AlreadyExistsException		Registration Groups exist for the formatOfferingId

Back to Operations

Method	getCourseOfferingDisplay
Description	Retrieves a single CourseOfferingDisplayInfo by a CourseOffering Id.
Parameters	String	courseOfferingId	an identifier for a CourseOffering
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	CourseOfferingDisplayInfo		a CourseOfferingDisplay
Errors	DoesNotExistException		courseOfferingId does not exist
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		courseOfferingId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getCourseOfferingDisplaysByIds
Description	Retrieve a list of CourseOfferingDisplayInfos corresponding to a list of CourseOfferingIds.
Parameters	StringList	courseOfferingIds	a list of CourseOffering identifiers
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	CourseOfferingDisplayInfoList		a list of CourseOfferingDisplayInfos
Errors	DoesNotExistException		a courseOfferingId in the list not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		courseOfferingIds, an Id in courseOfferingId, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getActivityOfferingDisplay
Description	Retrieves a single ActivityOfferingDisplayInfo by a ActivityOffering Id.
Parameters	String	activityOfferingId	an identifier for an ActivityOffering
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingDisplayInfo		an ActivityOfferingDisplay
Errors	DoesNotExistException		activityOfferingId does not exist
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		activityOfferingId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getActivityOfferingDisplaysByIds
Description	Retrieve a list of ActivitAOfferingAdminDisplayInfos corresponding to a list of ActivityOfferingIds.
Parameters	StringList	activityOfferingIds	a list of ActivityOffering identifiers
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingDisplayInfoList		a list of ActivityOfferingDisplayInfos
Errors	DoesNotExistException		an activityOfferingId in the list not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		activityOfferingIds, an Id in activityOfferingId, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getActivityOfferingDisplaysForCourseOffering
Description	Retrieve a list of ActivityOfferingDisplayInfos corresponding to a CourseOffering Id. Activity Offerings for all FormatOfferings within the given CourseOffering are used to assemble this administrative view.
Parameters	String	courseOfferingId	the identifier for a CourseOffering
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingDisplayInfoList		a list of ActivityOfferingDisplayInfos
Errors	DoesNotExistException		courseOfferingId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		courseOfferingId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getCourseOfferingType
Description	This method returns the TypeInfo for a given course offering type key.
Parameters	String	courseOfferingTypeKey	Key of the type
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfo		Information about the Type
Errors	DoesNotExistException		courseOfferingTypeKey not found
	InvalidParameterException		invalid courseOfferingTypeKey
	MissingParameterException		missing courseOfferingTypeKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCourseOfferingTypes
Description	This method returns the valid course offering types.
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		a list of valid course offering Types
Errors	InvalidParameterException		invalid context
	MissingParameterException		missing context
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getInstructorTypesForCourseOfferingType
Description	This method returns the valid instructor (lpr) types for a course offering type.
Parameters	String	courseOfferingTypeKey	a key for a course offering type
	ContextInfo	context	information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		a list of valid instructor types
Errors	DoesNotExistException		courseOfferingTypeKey not found
	InvalidParameterException		contextInfo is not valud
	MissingParameterException		courseOfferingTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getCourseOffering
Description	Retrieve information about a CourseOffering
Parameters	String	courseOfferingId	Unique Id of the CourseOffering
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	CourseOfferingInfo		???
Errors	DoesNotExistException		courseOfferingId not found
	InvalidParameterException		invalid courseOfferingId
	MissingParameterException		missing courseOfferingId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCourseOfferingsByIds
Description	Retrieves a list of course offerings by id list.
Parameters	StringList	courseOfferingIds	List of unique Ids of CourseOffering
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	CourseOfferingInfoList		???
Errors	DoesNotExistException		courseOfferingId in the list not found
	InvalidParameterException		invalid courseOfferingIds
	MissingParameterException		missing courseOfferingIds
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCourseOfferingsByCourse
Description	Retrieve CourseOfferings by canonical course id. This could return multiple offerings in cases of multiple offerings for formats and cross listed
Parameters	String	courseId	Unique Id of the Course (canonical)
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	CourseOfferingInfoList		???
Errors	DoesNotExistException		courseId or termId not found
	InvalidParameterException		invalid courseId or termId
	MissingParameterException		missing courseId or termId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCourseOfferingsByCourseAndTerm
Description	Retrieve CourseOfferings by canonical course id and term. This could return multiple offerings in cases of multiple offerings for formats and cross listed
Parameters	String	courseId	Unique Id of the Course (canonical)
	String	termId	Unique key of the term in which the course is being offered
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	CourseOfferingInfoList		???
Errors	DoesNotExistException		courseId or termId not found
	InvalidParameterException		invalid courseId or termId
	MissingParameterException		missing courseId or termId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCourseOfferingIdsByTerm
Description	Retrieve CourseOffering Ids for a given term and if useIncludedTerms is set to 'true' then use included terms also
Parameters	String	termId	Unique key of the term in which the course is being offered
	Boolean	useIncludedTerm	Indicates if the offerings from included term are also to be returned
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		List of CourseOffering Ids
Errors	DoesNotExistException		courseId or termId not found
	InvalidParameterException		invalid courseId or termId
	MissingParameterException		missing courseId or termId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCourseOfferingIdsByTermAndSubjectArea
Description	Retrieve CourseOffering Ids for a given term and subject area. A CourseOffering will have an official and "other" subject areas, this operation will the course offeiring ids with either official or other subject area that match.
Parameters	String	termId	Unique key of the term in which the course is being offered
	String	subjectArea	subject area
	ContextInfo	context	information about the caller of service operation
Return	StringList		List of CourseOffering Ids
Errors	DoesNotExistException		courseId or termId not found
	InvalidParameterException		invalid courseId or termId
	MissingParameterException		missing courseId or termId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCourseOfferingsByTermAndInstructor
Description	Retrieve Course Offerings for a given term and instructor id
Parameters	String	termId	Unique key of the term in which the course is being offered
	String	instructorId	person id of an instructor
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	CourseOfferingInfoList		List of CourseOffering Ids
Errors	DoesNotExistException		courseId or termId or instructorId not found
	InvalidParameterException		invalid courseId or termId
	MissingParameterException		missing courseId or termId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCourseOfferingIdsByTermAndUnitsContentOwner
Description	Retrieve CourseOffering Ids for a given term and unit content owner
Parameters	String	termId	Unique key of the term in which the course is being offered
	String	unitsContentOwnerId	Org Id of the Units content owner
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		List of CourseOffering Ids
Errors	DoesNotExistException		courseId or termId not found
	InvalidParameterException		invalid courseId or termId
	MissingParameterException		missing courseId or termId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCourseOfferingIdsByType
Description	Retrieve CourseOffering Ids for a given term and unit content owner
Parameters	String	typeKey	Unique key of the term in which the course is being offered
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		List of CourseOffering Ids
Errors	DoesNotExistException		courseId or termId not found
	InvalidParameterException		invalid courseId or termId
	MissingParameterException		missing courseId or termId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getValidCanonicalCourseToCourseOfferingOptionKeys
Description	Get the valid options that can be specified to control canonical course to course offering operations. This can happen in several situations: (1) When creating a course offering from scratch that copies data from the canonical (2) When a course is rolledOver and the "use canonical" option is specified in a rollover (3) When a course offering is explicitly asked to be updated based on the canonical (4) When a course offering is explicitly asked to be validated against the canonical These may identify fields to be copied or not copied or special checks or comparisons to be made, such as comparing that the credits of the course are consistent with the specified classroom hours. TODO: The exact types that can be specified here have not yet been defined
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of option keys used to to indicate the options to be used when copying data.
Errors	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???

Back to Operations

Method	getValidRolloverOptionKeys
Description	Get the valid rollover option keys This is the list of option keys supported by the rollover operation. Keys released with kuali student can be found here https://wiki.kuali.org/display/STUDENT/Course+Offering+Set+Types+and+States#CourseOfferingSetTypesandStates-RolloverOptionKeys
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of option keys
Errors	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???

Back to Operations

Method	createCourseOffering
Description	Creates a new course offering from a canonical course. Fields in course offering will be initialized with data from the canonical.
Parameters	String	courseId	Canonical course Id of courseOffering Id that the ActivityOffering will belong to
	String	termId	Unique key of the term in which the course is being offered course offering
	String	courseOfferingTypeKey	???
	CourseOfferingInfo	courseOfferingInfo	???
	StringList	optionKeys	options to use when copying data from the canonical
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	CourseOfferingInfo		newly created CourseOfferingInfo
Errors	DoesNotExistException		courseId not found
	DataValidationErrorException		One or more values invalid for this operation
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???

Back to Operations

Method	updateCourseOffering
Description	Updates an existing CourseOffering.
Parameters	String	courseOfferingId	Id of CourseOffering to be updated
	CourseOfferingInfo	courseOfferingInfo	Details of updates to the CourseOffering
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	CourseOfferingInfo		updated CourseOffering
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		the CourseOffering does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???
	VersionMismatchException		The action was attempted on an out of date version.

Back to Operations

Method	deleteCourseOffering
Description	Deletes an existing CourseOffering.
Parameters	String	courseOfferingId	the Id of the ActivityOffering to be deleted
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		the SeatPoolDefinition does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	DependentObjectsExistException		When one or more Format Offering, Activity Offering, Registration Group or Seat Pool Definition exist for course offering.

Back to Operations

Method	deleteCourseOfferingCascaded
Description	Deletes an existing CourseOffering cascaded style. Deleting a course offering cascaded style would also delete all the format offering, activity offerings, registration groups and seat pool definitions within it. Cross listed course offerings should also be deleted along with passed in courseOfferingId.
Parameters	String	courseOfferingId	the Id of the ActivityOffering to be deleted
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		the SeatPoolDefinition does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateCourseOffering
Description	Validates a course offering. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the academic calendar and a record is found for that identifier, the validation checks if the academic calendar can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	validationType	Identifier of the extent of validation
	CourseOfferingInfo	courseOfferingInfo	the course offering information to be tested.
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		the results from performing the validation
Errors	DoesNotExistException		validationTypeKey not found
	InvalidParameterException		invalid validationTypeKey, courseOfferingInfo
	MissingParameterException		missing validationTypeKey, courseOfferingInfo
	OperationFailedException		unable to complete request

Back to Operations

Method	getFormatOffering
Description	Gets an format offering based on Id.
Parameters	String	formatOfferingId	The Format Offering identifier
	ContextInfo	context	???
Return	FormatOfferingInfo		???
Errors	DoesNotExistException		The Format Offering doesn't exist
	InvalidParameterException		Invalid formatOfferingId
	MissingParameterException		Missing formatOfferingId
	OperationFailedException		unable to complete request
	PermissionDeniedException		???

Back to Operations

Method	getFormatOfferingsByCourseOffering
Description	Gets a list of format offering by a course offering id they belong to.
Parameters	String	courseOfferingId	Course offering identifier
	ContextInfo	context	???
Return	FormatOfferingInfoList		???
Errors	DoesNotExistException		The course offering doesn't exist
	InvalidParameterException		Invalid course offering id
	MissingParameterException		Missing course offering id
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createFormatOffering
Description	Creates an Format Offering for a course offering
Parameters	String	courseOfferingId	Course offering that the Format Offering belongs to
	String	formatId	???
	String	formatOfferingType	the type key of the Format Offering template
	FormatOfferingInfo	formatOfferingInfo	The Format Offering info object
	ContextInfo	context	???
Return	FormatOfferingInfo		???
Errors	DoesNotExistException		if courseOfferingId or formatId does not exist for the course in the course offering
	DataValidationErrorException		???
	InvalidParameterException		Invalid course offering id
	MissingParameterException		Missing course offering id, formatOfferingTemplate or formatOfferingType
	OperationFailedException		unable to complete request
	PermissionDeniedException		???
	ReadOnlyException		???

Back to Operations

Method	updateFormatOffering
Description	Update a Format Offering
Parameters	String	formatOfferingId	The Id formatOffering to be updated
	FormatOfferingInfo	formatOfferingInfo	The new formatOffering Info
	ContextInfo	context	???
Return	FormatOfferingInfo		???
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		The formatOfferingId doesn't exist
	InvalidParameterException		Invalid formatOfferingId or formatOffering
	MissingParameterException		Missing formatOffering or formatOfferingId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???
	VersionMismatchException		stale version being updated

Back to Operations

Method	validateFormatOffering
Description	Validates a format offering. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object.
Parameters	String	validationType	Identifier of the extent of validation
	FormatOfferingInfo	formatOfferingInfo	the format offering information to be tested.
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		the results from performing the validation
Errors	DoesNotExistException		validationTypeKey not found
	InvalidParameterException		invalid validationTypeKey, formatOfferingInfo
	MissingParameterException		missing validationTypeKey, formatOfferingInfo
	OperationFailedException		unable to complete request

Back to Operations

Method	deleteFormatOffering
Description	Deletes an Format Offering
Parameters	String	formatOfferingId	The Id formatOffering to be deleted
	ContextInfo	context	???
Return	StatusInfo		???
Errors	DoesNotExistException		The formatOfferingId doesn't exist
	InvalidParameterException		Invalid formatOfferingId
	MissingParameterException		Missing formatOfferingId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	DependentObjectsExistException		When one or more Activity Offering, Registration Group or Seat Pool Definition exist for the format offering.

Back to Operations

Method	deleteFormatOfferingCascaded
Description	Deletes an Format Offering with dependent Activity Offering and Registration group
Parameters	String	formatOfferingId	The Id formatOffering to be deleted
	ContextInfo	context	???
Return	StatusInfo		???
Errors	DoesNotExistException		The formatOfferingId doesn't exist
	InvalidParameterException		Invalid formatOfferingId
	MissingParameterException		Missing formatOfferingId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getActivityOfferingType
Description	This method returns the TypeInfo for a given activity offering type key.
Parameters	String	activityOfferingTypeKey	Key of the type
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfo		Information about the Type
Errors	DoesNotExistException		activityOfferingTypeKey not found
	InvalidParameterException		invalid activityOfferingTypeKey
	MissingParameterException		missing activityOfferingTypeKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getActivityOfferingTypes
Description	This method returns the valid activity offering types.
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		a list of valid activity offering Types
Errors	InvalidParameterException		invalid context
	MissingParameterException		missing context
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getActivityOfferingTypesForActivityType
Description	This method returns the valid activity offering types for a given canonical activity type
Parameters	String	activityTypeKey	Key of the canonical activity type
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		a list of valid activity offering Types
Errors	DoesNotExistException		activityOfferingTypeKey not found
	InvalidParameterException		invalid context
	MissingParameterException		missing context
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getInstructorTypesForActivityOfferingType
Description	This method returns the valid instructor (lpr) types for an activity offering type.
Parameters	String	activityOfferingTypeKey	a key for an activity offering type
	ContextInfo	context	information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		a list of valid instructor types
Errors	DoesNotExistException		activityOfferingTypeKey not found
	InvalidParameterException		context is not valud
	MissingParameterException		activityOfferingTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getActivityOffering
Description	Retrieve information about an ActivityOffering
Parameters	String	activityOfferingId	Unique Id of the ActivityOffering
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingInfo		ActivityOffering associated with the passed in Id
Errors	DoesNotExistException		seatPoolDefinitionId not found
	InvalidParameterException		invalid activityOfferingId
	MissingParameterException		missing activityOfferingId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getActivityOfferingsByIds
Description	Retrieves a list of activity offerings by id list.
Parameters	StringList	activityOfferingIds	List of unique Ids of ActivityCourseOffering
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingInfoList		Activity offering list
Errors	DoesNotExistException		activityOfferingId in the list not found
	InvalidParameterException		invalid activityOfferingIds
	MissingParameterException		missing activityOfferingIds
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getActivityOfferingsByCourseOffering
Description	Retrieves a list of ActivityOffering records that belongs to a CourseOffering.
Parameters	String	courseOfferingId	Unique Id of the CourseOffering
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingInfoList		List of ActivityOffering
Errors	DoesNotExistException		courseOfferingId not found
	InvalidParameterException		invalid courseOfferingId
	MissingParameterException		missing courseOfferingId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getActivityOfferingsByFormatOffering
Description	Retrieves a list of ActivityOffering records that belongs to a CourseOffering.
Parameters	String	formatOfferingId	Unique Id of the CourseOffering
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingInfoList		List of ActivityOffering
Errors	DoesNotExistException		formatOfferingId not found
	InvalidParameterException		invalid courseOfferingId
	MissingParameterException		missing courseOfferingId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getActivityOfferingsWithoutClusterByFormatOffering
Description	Retrieves a list of ActivityOffering records that belongs to a FormatOffering that are not associated with a cluster
Parameters	String	formatOfferingId	Id of the CourseOffering
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingInfoList		List of ActivityOfferings without cluster association
Errors	DoesNotExistException		formatOfferingId not found
	InvalidParameterException		invalid formatOfferingId
	MissingParameterException		formatOfferingId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getActivityOfferingsByFormatOfferingWithoutRegGroup
Description	Retrieves the Activity Offerings by actvity offering template id which don't have registration groups created for them yet.
Parameters	String	formatOfferingId	The Id of the format offering
	ContextInfo	context	???
Return	ActivityOfferingInfoList		???
Errors	DoesNotExistException		The formatOfferingId does not exist
	InvalidParameterException		Invalid formatOfferingId
	MissingParameterException		Missing formatOfferingId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createActivityOffering
Description	Creates a new Activity Offering for a format offering.
Parameters	String	formatOfferingId	courseOffering that the ActivityOffering belongs to
	String	activityId	the canonical activity this is associated with
	String	activityOfferingTypeKey	???
	ActivityOfferingInfo	activityOfferingInfo	Details of the ActivityOffering to be created
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingInfo		newly created ActivityOffering
Errors	DoesNotExistException		if the format offering does not exist
	DataValidationErrorException		One or more values invalid for this operation
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???

Back to Operations

Method	copyActivityOffering
Description	Creates a new Activity Offering from another activity offering, the generated activity offering is the same format offering, type and canonical activity as the source activity fofering
Parameters	String	activityOfferingId	the activity offering used as source
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingInfo		newly created ActivityOffering
Errors	DoesNotExistException		if the format offering does not exist
	DataValidationErrorException		One or more values invalid for this operation
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???

Back to Operations

Method	generateActivityOfferings
Description	Generates activity offerings based on a format offering.
Parameters	String	formatOfferingId	???
	String	activityOfferingType	???
	Integer	quantity	???
	ContextInfo	context	???
Return	ActivityOfferingInfoList		???
Errors	InvalidParameterException		formatOfferingId invalid
	MissingParameterException		Missing formatOfferingId in the input
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	updateActivityOffering
Description	Updates an existing ActivityOffering.
Parameters	String	activityOfferingId	Id of ActivitOffering to be updated
	ActivityOfferingInfo	activityOfferingInfo	Details of updates to the ActivityOffering
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingInfo		updated ActivityOffering
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		the ActivityOffering does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		The action was attempted on an out of date version.
	ReadOnlyException		???

Back to Operations

Method	deleteActivityOffering
Description	Deletes an existing ActivityOffering. Deleting an activity will also delete any relation it has with course offerings. An activity offering cannot be deleted if it is being referenced in a registration group and will be DependentObjectsExistException. The registration group needs to be updated to drop the activity offering references before the activity offering can be deleted. The difference in behavior is because of the relationship nature is different between course offering to activity offering and registration group to activity offering. Course offering contains activity offering, so deleting an activity offering can be logically interpreted as removing the containing relationship. Registration group only references existing activity offerings and hence deleting an activity offering will leave the registration group in inconsistent state and updating registration group automatically will lead to unintended side effects.
Parameters	String	activityOfferingId	the Id of the ActivityOffering to be deleted
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		the SeatPoolDefinition does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	DependentObjectsExistException		when one or more Registration Group and/or Seat Pool Definitions dependencies exist.

Back to Operations

Method	deleteActivityOfferingCascaded
Description	Deletes an existing ActivityOffering cascaded style. Deleting an activity offering cascaded style would also delete all the registration groups and seat pools associated with it.
Parameters	String	activityOfferingId	the Id of the ActivityOffering to be deleted
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		the SeatPoolDefinition does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateActivityOffering
Description	Validates an activity offering. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the academic calendar and a record is found for that identifier, the validation checks if the academic calendar can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	validationType	Identifier of the extent of validation
	ActivityOfferingInfo	activityOfferingInfo	the activity offering information to be tested.
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		the results from performing the validation
Errors	DoesNotExistException		validationTypeKey not found
	InvalidParameterException		invalid validationTypeKey, academicCalendarInfo
	MissingParameterException		missing validationTypeKey, academicCalendarInfo
	OperationFailedException		unable to complete request

Back to Operations

Method	calculateInClassContactHoursForTerm
Description	When/for how long does the offering meet in class during the term. Calculated by system based on meeting times and term length; may be validated against CLU.
Parameters	String	activityOfferingId	the Id of the ActivityOffering to be used for contact hour calculation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	Float		in class contact hours for the term
Errors	DoesNotExistException		the SeatPoolDefinition does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	calculateOutofClassContactHoursForTerm
Description	When/for how long does the offering meet out of class during the term. Calculated by system based on meeting times and term length; may be validated against CLU.
Parameters	String	activityOfferingId	the Id of the ActivityOffering to be used for contact hour calculation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	Float		out of class contact hours for the term
Errors	DoesNotExistException		the SeatPoolDefinition does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	calculateTotalContactHoursForTerm
Description	When/for how long does the offering meet in total during the term. Calculated by system based on meeting times and term length; may be validated against CLU.
Parameters	String	activityOfferingId	the Id of the ActivityOffering to be used for contact hour calculation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	Float		total class contact hours for the term
Errors	DoesNotExistException		the SeatPoolDefinition does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRegistrationGroup
Description	Retrieve a RegistrationGroup based on id
Parameters	String	registrationGroupId	Unique Id of the RegistrationGroup
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	RegistrationGroupInfo		RegistrationGroup associated with the passed in Id
Errors	DoesNotExistException		registrationGroupId not found
	InvalidParameterException		invalid registrationGroupId
	MissingParameterException		missing registrationGroupId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRegistrationGroupsByIds
Description	Retrieves a list of registration group by id list.
Parameters	StringList	registrationGroupIds	List of unique Ids of RegistrationGroup
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	RegistrationGroupInfoList		Registration Group list
Errors	DoesNotExistException		registrationGroupId in the list not found
	InvalidParameterException		invalid registrationGroupIds
	MissingParameterException		missing registrationGroupIds
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRegistrationGroupsForCourseOffering
Description	Retrieves a list of RegistrationGroup records that belongs to a CourseOffering
Parameters	String	courseOfferingId	Unique Id of the CourseOffering
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	RegistrationGroupInfoList		List of RegistrationGroups
Errors	DoesNotExistException		courseOfferingId not found
	InvalidParameterException		invalid courseOfferingId
	MissingParameterException		missing courseOfferingId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRegistrationGroupsWithActivityOfferings
Description	Retrieves a list of RegistrationGroup records that contain all the activity offerings in the input list.
Parameters	StringList	activityOfferingIds	List of activityOffering Identifiers
	ContextInfo	context	???
Return	RegistrationGroupInfoList		???
Errors	DoesNotExistException		One or more of the activityOfferingIds doesn't exist
	InvalidParameterException		One or more invalid activityOfferingIds
	MissingParameterException		Missing activityOfferingIds
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRegistrationGroupsByFormatOffering
Description	Retrieves a list of RegistrationGroup records that belongs to a CourseOffering for a given canonical format type
Parameters	String	formatOfferingId	Unique Id of the CourseOffering
	ContextInfo	context	information containing the principalId and locale information about the caller of service operation
Return	RegistrationGroupInfoList		List of RegistrationGroups
Errors	DoesNotExistException		courseOfferingId or formatTypeKey not found
	InvalidParameterException		invalid courseOfferingId or formatTypeKey
	MissingParameterException		missing courseOfferingId or formatTypeKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateRegistrationGroup
Description	Validates a registration group. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained subobjects or expanded to perform all tests related to this object. If an identifier is present for the academic calendar and a record is found for that identifier, the validation checks if the academic calendar can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	validationType	Identifier of the extent of validation
	RegistrationGroupInfo	registrationGroupInfo	the registrationGroup information to be tested.
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		a list of validation results or an empty list if validation succeeded
Errors	DoesNotExistException		validationTypeKey not found
	InvalidParameterException		invalid validationTypeKey, academicCalendarInfo
	MissingParameterException		missing validationTypeKey, academicCalendarInfo
	OperationFailedException		unable to complete request

Back to Operations

Method	createRegistrationGroup
Description	Creates a new Registration Group.
Parameters	String	formatOfferingId	formatofferingId that the RegistrationGroup is based on
	String	registrationGroupType	courseOffering Id that the RegistrationGroup will belong to
	RegistrationGroupInfo	registrationGroupInfo	Details of the RegistrationGroup to be created
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	RegistrationGroupInfo		newly created registrationGroup
Errors	DoesNotExistException		courseOfferingId not found
	DataValidationErrorException		One or more values invalid for this operation
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???

Back to Operations

Method	updateRegistrationGroup
Description	Updates an existing RegistrationGroup.
Parameters	String	registrationGroupId	Id of RegistrationGroup to be updated
	RegistrationGroupInfo	registrationGroupInfo	Details of updates to the RegistrationGroup
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	RegistrationGroupInfo		updated RegistrationGroup
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		the registrationGroupId does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???
	VersionMismatchException		The action was attempted on an out of date version.

Back to Operations

Method	deleteRegistrationGroup
Description	Deletes an existing Registration Group. Removes the relationship to the course offering and activity offering. The activity offerings are not automatically deleted
Parameters	String	registrationGroupId	the Id of the RegistrationGroup to be deleted
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		???
Errors	DoesNotExistException		the RegistrationGroup does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	deleteRegistrationGroupsByFormatOffering
Description	Deletes all Registration Groups for a Format Offering.
Parameters	String	formatOfferingId	the Id of the FormatOffering
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		???
Errors	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	deleteGeneratedRegistrationGroupsByFormatOffering
Description	Deletes all generated Registration Groups for a Format Offering. A generated registration group is one whose isGenerated() flag is true.
Parameters	String	formatOfferingId	the Id of the FormatOffering
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		???
Errors	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	deleteRegistrationGroupsForCluster
Description	Deletes all Registration Groups associated with an Activity Offering Cluster
Parameters	String	activityOfferingClusterId	the Id of the FormatOffering
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		activityOfferingClusterId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure has occurred

Back to Operations

Method	verifyRegistrationGroup
Description	Verifies a Registration Group applying rules such as: (1) Reg Group has one of each AO type (2) AO's don't meet at the same time (if scheduling has already happened) (3) AO's are all offered at the same campus (4) AO's don't have conflicting seatpool/enrollment restrictions
Parameters	String	registrationGroupId	the registrationGroup information to be tested.
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		a list of validation results or an empty list if validation succeeded
Errors	DoesNotExistException		contextInfo not found
	InvalidParameterException		invalid registrationGroupId or contextInfo
	MissingParameterException		registrationGroupId or contextInfo is missing or null
	OperationFailedException		unable to complete request

Back to Operations

Method	getActivityOfferingCluster
Description	Gets an Activity Offering Cluster based on the Identifier
Parameters	String	activityOfferingClusterId	Identifier of the Activity Offering Cluster
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingClusterInfo		ActivityOfferingCluster
Errors	DoesNotExistException		activityOfferingClusterId does not exist
	InvalidParameterException		Invalid contextInfo
	MissingParameterException		activityOfferingClusterId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getActivityOfferingClustersByFormatOffering
Description	Retrieves a list of ActivityOfferingClusters associated with a FormatOffering
Parameters	String	formatOfferingId	Id of the FormatOffering
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingClusterInfoList		List of ActivityOffering
Errors	DoesNotExistException		courseOfferingId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		formatOfferingId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	validateActivityOfferingCluster
Description	Validates an Activity Offering Cluster. Depending on the value of validationTypeKey, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the academic calendar and a record is found for that identifier, the validation checks if the academic calendar can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationTypeKey to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	validationTypeKey	Identifier of the extent of validation
	String	formatOfferingId	Format Offering identifier
	String	activityOfferingClusterTypeKey	Activity Offering Cluster type
	ActivityOfferingInfo	activityOfferingClusterInfo	the Activity Offering Cluster information to be validated.
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		the results from performing the validation
Errors	DoesNotExistException		validationTypeKey or activityOfferingClusterTypeKey not found
	InvalidParameterException		invalid activityOfferingClusterInfo or contextInfo
	MissingParameterException		validationTypeKey, activityOfferingClusterTypeKey, activityOfferingClusterInfo or contextInfo is missing or null
	OperationFailedException		unable to complete request

Back to Operations

Method	createActivityOfferingCluster
Description	Creates a new Activity Offering Cluster from the given Format Offering
Parameters	String	formatOfferingId	Format Offering identifier
	String	activityOfferingClusterTypeKey	Activity Offering Cluster type
	ActivityOfferingClusterInfo	activityOfferingClusterInfo	Details of the ActivityOfferingCluster to be created
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingClusterInfo		newly created ActivityOfferingCluster
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		validationTypeKey or activityOfferingClusterTypeKey not found
	InvalidParameterException		invalid activityOfferingClusterInfo or contextInfo
	MissingParameterException		validationTypeKey, activityOfferingClusterTypeKey or activityOfferingClusterInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure has occurred
	ReadOnlyException		an attempt at supplying information designated as read only

Back to Operations

Method	updateActivityOfferingCluster
Description	Updates an ActivityOfferingCluster based on the info object
Parameters	String	formatOfferingId	Format Offering identifier
	String	activityOfferingClusterId	Identifier of the Activity Offering Cluster
	ActivityOfferingClusterInfo	activityOfferingClusterInfo	ActivityOfferingCluster with new information
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ActivityOfferingClusterInfo		updated ActivityOfferingCluster
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		activityOfferingClusterId does not exist
	InvalidParameterException		Invalid activityOfferingClusterInfo
	MissingParameterException		activityOfferingClusterId or activityOfferingClusterInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure has occurred
	ReadOnlyException		an attempt at supplying information designated as read only
	VersionMismatchException		optimistic locking failure or the action was attempted on an out of date version

Back to Operations

Method	deleteActivityOfferingCluster
Description	Deletes an activity offering cluster based on the identifier
Parameters	String	activityOfferingClusterId	Identifier of the Activity Offering Cluster
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		activityOfferingClusterId does not exist
	InvalidParameterException		Invalid contextInfo
	MissingParameterException		activityOfferingClusterId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure has occurred

Back to Operations

Method	verifyActivityOfferingClusterForGeneration
Description	Verifies an Activity Offering Cluster completeness for generation, verifying that each of the created RegGroups will be legitimate
Parameters	String	activityOfferingClusterId	Activity Offering Cluster to be verified
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		a list of validation results or an empty list if validation succeeded
Errors	DoesNotExistException		activityOfferingClusterId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		activityOfferingClusterId or contextInfo is missing or null
	OperationFailedException		unable to complete request

Back to Operations

Method	generateRegistrationGroupsForCluster
Description	Generates all possible registration groups for the Activity Offering Cluster
Parameters	String	activityOfferingClusterId	identifier of the Activity Offering Cluster
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	RegistrationGroupInfoList		generated registrationGroups for the cluster
Errors	DoesNotExistException		activityOfferingClusterId does not exist
	InvalidParameterException		invalid contextInfo
	MissingParameterException		activityOfferingClusterId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure has occurred

Back to Operations

Method	getSeatPoolDefinition
Description	Retrieve information about a SeatPoolDefinition
Parameters	String	seatPoolDefinitionId	Unique Id of the SeatPoolDefinition
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	SeatPoolDefinitionInfo		SeatPoolDefinition associated with the passed in Id
Errors	DoesNotExistException		seatPoolDefinitionId not found
	InvalidParameterException		invalid seatPoolDefinitionId
	MissingParameterException		missing seatPoolDefinitionId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getSeatPoolDefinitionsForActivityOffering
Description	Retrieves a list of SeatPoolDefinitions records that belongs to an ActivityOffering. This should return SeatPoolDefinitions that apply globally across all RegistrationGroups in the ActivityOffering.
Parameters	String	activityOfferingId	Unique Id of the ActivityOffering
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	SeatPoolDefinitionInfoList		List of SeatPoolDefinitions
Errors	DoesNotExistException		activityOfferingId not found
	InvalidParameterException		invalid activityOfferingId
	MissingParameterException		missing activityOfferingId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createSeatPoolDefinition
Description	Creates a new Seat Pool
Parameters	SeatPoolDefinitionInfo	seatPoolDefinitionInfo	Details of the SeatPoolDefinition to be created
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	SeatPoolDefinitionInfo		newly created SeatPoolDefinition
Errors	DataValidationErrorException		One or more values invalid for this operation
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???

Back to Operations

Method	updateSeatPoolDefinition
Description	Updates an existing SeatPoolDefinition.
Parameters	String	seatPoolDefinitionId	Id of SeatPoolDefinition to be updated
	SeatPoolDefinitionInfo	seatPoolDefinitionInfo	Details of updates to the SeatPoolDefinition
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	SeatPoolDefinitionInfo		updated SeatPoolDefinition
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		the SeatPoolDefinition does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???
	VersionMismatchException		The action was attempted on an out of date version.

Back to Operations

Method	validateSeatPoolDefinition
Description	Validate a seat pool definition
Parameters	String	validationTypeKey	???
	SeatPoolDefinitionInfo	seatPoolDefinitionInfo	???
	ContextInfo	context	???
Return	ValidationResultInfoList		???
Errors	DataValidationErrorException		???
	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???
	VersionMismatchException		???

Back to Operations

Method	deleteSeatPoolDefinition
Description	Deletes an existing SeatPoolDefinition.
Parameters	String	seatPoolDefinitionId	the Id of the SeatPoolDefinition to be deleted
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		???
Errors	DoesNotExistException		the SeatPoolDefinition does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	addSeatPoolDefinitionToActivityOffering
Description	Add a SeatPoolDefinition to an ActivityOffering
Parameters	String	seatPoolDefinitionId	a unique identifier for a SeatPoolDefinition
	String	activityOfferingId	a unique identifier for an ActivityOffering
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status
Errors	AlreadyExistsException		seatPoolDefinitionId already related to activityOfferingId
	DoesNotExistException		seatPoolDefinitionId or activityOfferingId not found
	InvalidParameterException		invalid seatPoolDefinitionId, activityOfferingId, or contextInfo
	MissingParameterException		missing seatPoolDefinitionId, activityOfferingId, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	removeSeatPoolDefinitionFromActivityOffering
Description	Removes a SeatPoolDefinition from an ActivityOffering.
Parameters	String	seatPoolDefinitionId	a unique identifier for a SeatPoolDefinition
	String	activityOfferingId	a unique identifier for an ActivityOffering
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status
Errors	DoesNotExistException		seatPoolDefinitionId or activityOfferingId not found
	InvalidParameterException		invalid seatPoolDefinitionId, activityOfferingId, or contextInfo
	MissingParameterException		missing seatPoolDefinitionId, activityOfferingId, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForCourseOfferings
Description	Searches for course offerings using a free form search criteria
Parameters	QueryByCriteria	criteria	???
	ContextInfo	context	???
Return	CourseOfferingInfoList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	searchForCourseOfferingIds
Description	Searches for course offering ids using a free form search criteria
Parameters	QueryByCriteria	criteria	???
	ContextInfo	context	???
Return	StringList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	searchForActivityOfferings
Description	Searches for activity offerings using a free form search criteria
Parameters	QueryByCriteria	criteria	???
	ContextInfo	context	???
Return	ActivityOfferingInfoList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	searchForActivityOfferingIds
Description	Searches for activity offering ids using a free form search criteria
Parameters	QueryByCriteria	criteria	???
	ContextInfo	context	???
Return	StringList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	searchForRegistrationGroups
Description	Searches for registration group ids using a free form search criteria
Parameters	QueryByCriteria	criteria	???
	ContextInfo	context	???
Return	RegistrationGroupInfoList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	searchForRegistrationGroupIds
Description	Searches for registration group ids using a free form search criteria.
Parameters	QueryByCriteria	criteria	???
	ContextInfo	context	???
Return	StringList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	searchForSeatpoolDefinitions
Description	Searches for seat pool definition ids using a free form search criteria
Parameters	QueryByCriteria	criteria	???
	ContextInfo	context	???
Return	SeatPoolDefinitionInfoList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	searchForSeatpoolDefinitionIds
Description	Searches for seat pool definition ids using a free form search criteria
Parameters	QueryByCriteria	criteria	???
	ContextInfo	context	???
Return	StringList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations