CourseWaitlistService

• getAvailableSeatsForCourseOffering
• getAvailableSeatsForRegGroup
• getAvailableSeatsForStudentInRegGroup
• getAvailableSeatsInSeatpool
• getCourseWaitlistEntry
• updateCourseWaitlistEntry
• reorderCourseWaitlistEntries
• insertCourseWaitlistEntryAtPosition
• removeCourseWaitlistEntry
• deleteCourseWaitlistEntry
• validateCourseWaitlistEntry
• registerStudentFromWaitlist
• getCourseWaitlistEntriesForCourseOffering
• getCourseWaitlistEntriesForRegGroup
• getCourseWaitlistEntriesForStudentInCourseOffering
• getCourseWaitlistEntryForStudentInRegGroup
• getCourseWaitlistEntriesForStudentByTerm
• searchForCourseWaitlistEntries
• searchForCourseWaitlistEntryIds

• CourseWaitlistEntryInfo
• StatusInfo
• RegistrationResponseInfo
• QueryByCriteria

Method	getAvailableSeatsForCourseOffering
Description	Retrieves the open seat count for a particular course offering. It sums up the open seats for individual registration groups under the same course offering.
Parameters	String	courseOfferingId	???
	ContextInfo	context	???
Return	Integer		???
Errors	InvalidParameterException		Invalid courseOfferingId in the input
	MissingParameterException		Missing courseOfferingId in the input
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Not authorized to do this operation

Back to Operations

Method	getAvailableSeatsForRegGroup
Description	Get available seats for the registration group.
Parameters	String	regGroupId	Identifier of the registration group
	ContextInfo	context	???
Return	Integer		???
Errors	InvalidParameterException		Invalid regGroupId in the input
	MissingParameterException		Missing regGroupId in the input
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Not authorized to do this operation

Back to Operations

Method	getAvailableSeatsForStudentInRegGroup
Description	Gets the number of seats available for a particular student in a registration group. Implementation notes : Seats available for a student taking seat pool (if any) into consideration.
Parameters	String	studentId	Identifier of the student
	String	regGroupId	Identifier of the registration group
	ContextInfo	context	???
Return	Integer		???
Errors	InvalidParameterException		Invalid studentId or regGroupId in the input
	MissingParameterException		Missing studentId or regGroupId in the input
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Not authorized to do this operation

Back to Operations

Method	getAvailableSeatsInSeatpool
Description	Returns the available seats in a particular seat pool. This is an admin support function to check the seat pool usage.
Parameters	String	seatpoolId	Identifier of the seatpool
	ContextInfo	context	???
Return	Integer		???
Errors	InvalidParameterException		Invalid seatpool in the input
	MissingParameterException		Missing parameter seatpoolId in the input
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Not authorized to do this operation

Back to Operations

Method	getCourseWaitlistEntry
Description	Gets a course waitlist entry by id.
Parameters	String	courseWaitlistEntryId	Id of the course waitlist entry
	ContextInfo	context	???
Return	CourseWaitlistEntryInfo		???
Errors	DoesNotExistException		No courseWaitlistEntryId exists
	InvalidParameterException		Invalid courseWaitlistEntryId
	MissingParameterException		Missing courseWaitlistEntryId in the input
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Not authorized to do this operation

Back to Operations

Method	updateCourseWaitlistEntry
Description	Updates a course waitlist entry
Parameters	String	courseWaitlistEntryId	Id of the course waitlist entry to be updated
	CourseWaitlistEntryInfo	courseWaitlistEntryInfo	The modified {@link CourseWaitlistEntryInfo}
	ContextInfo	context	???
Return	StatusInfo		???
Errors	DoesNotExistException		???
	DataValidationErrorException		The courseWaitlistEntryInfo is not valid
	InvalidParameterException		Invalid courseWaitlistEntryId or courseWaitlistEntryInfo in the input
	MissingParameterException		Missing courseWaitlistEntryId or courseWaitlistEntryInfo in the input
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Not authorized to do this operation

Back to Operations

Method	reorderCourseWaitlistEntries
Description	Reorder all the entries that are passed in in the input list, i.e., update each of the entries rank to begin from the top and push the entries not in the list to the ranks after the entries.
Parameters	StringList	courseWaitlistEntryIds	???
	ContextInfo	context	???
Return	StatusInfo		???
Errors	DoesNotExistException		???
	InvalidParameterException		Invalid courseWaitlistEntryIds in the input
	MissingParameterException		Missing courseWaitlistEntryIdsin the input
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Not authorized to do this operation

Back to Operations

Method	insertCourseWaitlistEntryAtPosition
Description	Insert a waitlist entry at a particular position in the waitlist. The courseWaitlistEntryId would be moved to the position and all other waitlist entries for that reg group would have adjusted rank
Parameters	String	courseWaitlistEntryId	The id of the course waitlist entry
	Integer	position	The new rank for the waitlist entry
	ContextInfo	context	???
Return	StatusInfo		???
Errors	DoesNotExistException		The courseWaitlistEntryId is not found
	InvalidParameterException		The courseWaitlistEntryId is invalid
	MissingParameterException		Input courseWaitlistEntryId or position is missing
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Not authorized to do this operation

Back to Operations

Method	removeCourseWaitlistEntry
Description	Remove the {@link CourseWaitlistEntryInfo}, change its state to CANCELLED
Parameters	String	courseWaitlistEntryId	The id of the course waitlist entry
	ContextInfo	context	???
Return	StatusInfo		???
Errors	DoesNotExistException		The courseWaitlistEntryId is not found
	InvalidParameterException		The courseWaitlistEntryId is invalid
	MissingParameterException		Input courseWaitlistEntryId or position is missing
	OperationFailedException		Unable to complete request
	PermissionDeniedException		Not authorized to do this operation

Back to Operations

Method	deleteCourseWaitlistEntry
Description	Deletes a course waitlist entry
Parameters	String	courseWaitlistEntryId	???
	ContextInfo	context	???
Return	StatusInfo		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	validateCourseWaitlistEntry
Description	Validates a course waitlist entry.
Parameters	String	validateTypeKey	???
	CourseWaitlistEntryInfo	courseWaitlistEntryInfo	???
	ContextInfo	context	???
Return	StatusInfo		???
Errors	DataValidationErrorException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	registerStudentFromWaitlist
Description	Register a student to a reg group from a waitlist.
Parameters	String	courseWaitlistEntryId	???
	ContextInfo	context	???
Return	RegistrationResponseInfo		???
Errors	AlreadyExistsException		???
	DataValidationErrorException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getCourseWaitlistEntriesForCourseOffering
Description	Gets the course waitlist entries for a course offering. Returns all students who are on waitlists for that course offering.
Parameters	String	courseOfferingId	???
	ContextInfo	context	???
Return	CourseWaitlistEntryInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getCourseWaitlistEntriesForRegGroup
Description	Gets the course waitlist entries for a reg group.
Parameters	String	regGroupId	???
	ContextInfo	context	???
Return	CourseWaitlistEntryInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getCourseWaitlistEntriesForStudentInCourseOffering
Description	Gets the waitlist entries for a course offering by student. A student might be listed in multiple reg group waitlists in the same course.
Parameters	String	courseOfferingId	???
	String	studentId	???
	ContextInfo	context	???
Return	CourseWaitlistEntryInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getCourseWaitlistEntryForStudentInRegGroup
Description	Gets the waitlist for a reg group and student.
Parameters	String	regGroupId	???
	String	studentId	???
	ContextInfo	context	???
Return	CourseWaitlistEntryInfo		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	getCourseWaitlistEntriesForStudentByTerm
Description	Get all the waitlist the student is in for a term. Returns CourseWaitlistEntryInfo which is the student-waitlist relation.
Parameters	String	studentId	???
	String	termId	???
	ContextInfo	context	???
Return	CourseWaitlistEntryInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	searchForCourseWaitlistEntries
Description	This method ...
Parameters	QueryByCriteria	criteria	???
	ContextInfo	context	???
Return	CourseWaitlistEntryInfoList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations

Method	searchForCourseWaitlistEntryIds
Description	This method ...
Parameters	QueryByCriteria	criteria	???
	ContextInfo	context	???
Return	StringList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	PermissionDeniedException		???

Back to Operations