SchedulingService

• getSchedule
• getSchedulesByIds
• getScheduleIdsByType
• searchForScheduleIds
• searchForSchedules
• validateSchedule
• createSchedule
• updateSchedule
• deleteSchedule
• getScheduleBatch
• getScheduleBatchesByIds
• getScheduleBatchIdsByType
• searchForScheduleBatchIds
• searchForScheduleBatches
• validateScheduleBatch
• createScheduleBatch
• updateScheduleBatch
• deleteScheduleBatch
• getScheduleRequest
• getScheduleRequestsByIds
• getScheduleRequestIdsByType
• getScheduleRequestIdsByRefObject
• getScheduleRequestsByRefObject
• searchForScheduleRequestIds
• searchForScheduleRequests
• validateScheduleRequest
• createScheduleRequest
• updateScheduleRequest
• deleteScheduleRequest
• getTimeSlot
• getTimeSlotsByIds
• getTimeSlotIdsByType
• getTimeSlotsByDaysAndStartTime
• getTimeSlotsByDaysAndStartTimeAndEndTime
• searchForTimeSlotIds
• searchForTimeSlots
• validateTimeSlot
• createTimeSlot
• updateTimeSlot
• deleteTimeSlot
• submitScheduleBatch
• commitSchedules
• getValidDaysOfWeekByTimeSlotType
• getScheduleBatchesForScheduleTransaction
• getScheduleTransaction
• getScheduleTransactionsByIds
• getScheduleTransactionIdsByType
• getScheduleTransactionIdsByRefObject
• getScheduleTransactionsByRefObject
• getScheduleTransactionsForScheduleBatch
• searchForScheduleTransactionIds
• searchForScheduleTransactions
• validateScheduleTransaction
• createScheduleTransaction
• updateScheduleTransaction
• deleteScheduleTransaction
• areTimeSlotsInConflict

• ScheduleInfo
• QueryByCriteria
• ValidationResultInfo
• StatusInfo
• ScheduleBatchInfo
• ScheduleRequestInfo
• TimeSlotInfo
• ScheduleTransactionInfo

Method	getSchedule
Description	Retrieves a Schedule
Parameters	String	scheduleId	unique Id of a Schedule
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleInfo		the Schedule
Errors	DoesNotExistException		scheduleId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getSchedulesByIds
Description	Retrieves a list of Schedules corresponding to the given list of Schedule Ids.
Parameters	StringList	scheduleIds	list of Schedules to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleInfoList		a list of Schedules
Errors	DoesNotExistException		a scheduleId in list not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleIdsByType
Description	Retrieves a list of Schedule Ids by Schedule Type.
Parameters	String	scheduleTypeKey	an identifier for a Schedule Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Schedule identifiers matching scheduleTypeKey or an empty list if none found
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForScheduleIds
Description	Searches for Schedules based on the criteria and returns a list of Schedule 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 Schedule Ids
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForSchedules
Description	Searches for Schedules based on the criteria and returns a list of Schedules 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	ScheduleInfoList		list of Schedules
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateSchedule
Description	Validates a Schedule. Depending on the value of validationType, this validation could be limited to tests on just the current Schedule and its directly contained sub-objects or expanded to perform all tests related to this Schedule. If an identifier is present for the Schedule (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the Schedule can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the object with the given data can be created.
Parameters	String	validationTypeKey	the identifier for the validation Type
	String	scheduleTypeKey	the identifier for the schedule Type
	ScheduleInfo	scheduleInfo	detailed information about the schedule
	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		validationTypeKey, scheduleId, not found
	InvalidParameterException		invalid scheduleInfo or contextInfo
	MissingParameterException		validationTypeKey, scheduleId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	createSchedule
Description	Creates a Schedule
Parameters	String	scheduleTypeKey	the identifier for the schedule Type
	ScheduleInfo	scheduleInfo	detailed information about the schedule
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleInfo		detailed information about the schedule
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		scheduleId does not exist
	InvalidParameterException		invalid scheduleInfo or contextInfo
	MissingParameterException		scheduleId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at supplying information designated as read only

Back to Operations

Method	updateSchedule
Description	Updates a schedule.
Parameters	String	scheduleId	identifier of the schedule to be updated
	ScheduleInfo	scheduleInfo	information about the object scheduleInfo to be updated
	ContextInfo	contextInfo	context information containing the principalId and locale information about the caller of service operation
Return	ScheduleInfo		updated schedule information
Errors	DataValidationErrorException		one or more values invalid for this operation
	DoesNotExistException		scheduleId not found
	InvalidParameterException		invalid scheduleInfo or contextInfo
	MissingParameterException		scheduleId, scheduleInfo or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure 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	deleteSchedule
Description	Removes schedule relationship between a person and a slot.
Parameters	String	scheduleId	Schedule identifier
	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		scheduleId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleBatch
Description	Retrieves a ScheduleBatch
Parameters	String	scheduleBatchId	a unique Id of a ScheduleBatch
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleBatchInfo		the ScheduleBatch
Errors	DoesNotExistException		scheduleBatchId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleBatchId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleBatchesByIds
Description	Retrieves a list of ScheduleBatches corresponding to the given list of ScheduleBatch Ids.
Parameters	StringList	scheduleBatchIds	list of ScheduleBatches to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleBatchInfoList		a list of ScheduleBatches
Errors	DoesNotExistException		a scheduleBatchId in list not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing scheduleBatchId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleBatchIdsByType
Description	Retrieves a list of ScheduleBatch Ids by ScheduleBatch Type.
Parameters	String	scheduleBatchTypeKey	an identifier for a ScheduleBatch Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of ScheduleBatch identifiers matching scheduleBatchTypeKey or an empty list if none found
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleBatchTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForScheduleBatchIds
Description	Searches for ScheduleBatches based on the criteria and returns a list of ScheduleBatch 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 ScheduleBatch Ids
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForScheduleBatches
Description	Searches for ScheduleBatches based on the criteria and returns a list of ScheduleBatches 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	ScheduleBatchInfoList		list of ScheduleBatches
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateScheduleBatch
Description	Validates a ScheduleBatch. Depending on the value of validationType, this validation could be limited to tests on just the current ScheduleBatch and its directly contained sub-objects or expanded to perform all tests related to this ScheduleBatch. If an identifier is present for the ScheduleBatch (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the ScheduleBatch can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the object with the given data can be created.
Parameters	String	validationTypeKey	the identifier for the validation Type
	String	scheduleBatchTypeKey	the identifier for the scheduleBatch Type
	ScheduleBatchInfo	scheduleBatchInfo	detailed information about the scheduleBatch
	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		validationTypeKey, scheduleBatchId, not found
	InvalidParameterException		invalid scheduleBatchInfo or contextInfo
	MissingParameterException		validationTypeKey, scheduleBatchId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	createScheduleBatch
Description	Creates a ScheduleBatch
Parameters	String	scheduleBatchTypeKey	the identifier for the scheduleBatch Type
	ScheduleBatchInfo	scheduleBatchInfo	detailed information about the scheduleBatch
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleBatchInfo		detailed information about the scheduleBatch
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		scheduleBatchId does not exist
	InvalidParameterException		invalid scheduleBatchInfo or contextInfo
	MissingParameterException		scheduleBatchId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at supplying information designated as read only

Back to Operations

Method	updateScheduleBatch
Description	Updates a scheduleBatch.
Parameters	String	scheduleBatchId	identifier of the scheduleBatch to be updated
	ScheduleBatchInfo	scheduleBatchInfo	information about the object scheduleBatchInfo to be updated
	ContextInfo	contextInfo	context information containing the principalId and locale information about the caller of service operation
Return	ScheduleBatchInfo		updated scheduleBatch information
Errors	DataValidationErrorException		one or more values invalid for this operation
	DoesNotExistException		scheduleBatchId not found
	InvalidParameterException		invalid scheduleBatchInfo or contextInfo
	MissingParameterException		scheduleBatchId, scheduleBatchInfo or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure 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	deleteScheduleBatch
Description	Removes scheduleBatch relationship between a person and a slot.
Parameters	String	scheduleBatchId	ScheduleBatch identifier
	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		scheduleBatchId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleBatchId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleRequest
Description	Retrieves a ScheduleRequest
Parameters	String	scheduleRequestId	a unique Id of a ScheduleRequest
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleRequestInfo		the ScheduleRequest
Errors	DoesNotExistException		scheduleRequestId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleRequestId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleRequestsByIds
Description	Retrieves a list of ScheduleRequests corresponding to the given list of ScheduleRequest Ids.
Parameters	StringList	scheduleRequestIds	list of ScheduleRequests to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleRequestInfoList		a list of ScheduleRequests
Errors	DoesNotExistException		a scheduleRequestId in list not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing scheduleRequestId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleRequestIdsByType
Description	Retrieves a list of ScheduleRequest Ids by ScheduleRequest Type.
Parameters	String	scheduleRequestTypeKey	an identifier for a ScheduleRequest Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of ScheduleRequest identifiers matching scheduleRequestTypeKey or an empty list if none found
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleRequestTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleRequestIdsByRefObject
Description	Retrieves a list of ScheduleRequest Ids by Ref Object Type.
Parameters	String	refObjectType	an identifier for a ref object Type
	String	refObjectId	an
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of ScheduleRequest identifiers matching scheduleRequestTypeKey or an empty list if none found
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleRequestTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleRequestsByRefObject
Description	Retrieves a list of ScheduleRequest objects by Ref Object Type.
Parameters	String	refObjectType	an identifier for a ref object Type
	String	refObjectId	an
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleRequestInfoList		a list of ScheduleRequest objects matching scheduleRequestTypeKey or an empty list if none found
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleRequestTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForScheduleRequestIds
Description	Searches for ScheduleRequests based on the criteria and returns a list of ScheduleRequest 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 ScheduleRequest Ids
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForScheduleRequests
Description	Searches for ScheduleRequests based on the criteria and returns a list of ScheduleRequests 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	ScheduleRequestInfoList		list of ScheduleRequests
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateScheduleRequest
Description	Validates a ScheduleRequest. Depending on the value of validationType, this validation could be limited to tests on just the current ScheduleRequest and its directly contained sub-objects or expanded to perform all tests related to this ScheduleRequest. If an identifier is present for the ScheduleRequest (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the ScheduleRequest can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the object with the given data can be created.
Parameters	String	validationTypeKey	the identifier for the validation Type
	String	scheduleRequestTypeKey	the identifier for the scheduleRequest Type
	ScheduleRequestInfo	scheduleRequestInfo	detailed information about the scheduleRequest
	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		validationTypeKey, scheduleRequestId, not found
	InvalidParameterException		invalid scheduleRequestInfo or contextInfo
	MissingParameterException		validationTypeKey, scheduleRequestId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	createScheduleRequest
Description	Creates a ScheduleRequest
Parameters	String	scheduleRequestTypeKey	the identifier for the scheduleRequest Type
	ScheduleRequestInfo	scheduleRequestInfo	detailed information about the scheduleRequest
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleRequestInfo		detailed information about the scheduleRequest
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		scheduleRequestId does not exist
	InvalidParameterException		invalid scheduleRequestInfo or contextInfo
	MissingParameterException		scheduleRequestId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at supplying information designated as read only

Back to Operations

Method	updateScheduleRequest
Description	Updates a scheduleRequest.
Parameters	String	scheduleRequestId	identifier of the scheduleRequest to be updated
	ScheduleRequestInfo	scheduleRequestInfo	information about the object scheduleRequestInfo to be updated
	ContextInfo	contextInfo	context information containing the principalId and locale information about the caller of service operation
Return	ScheduleRequestInfo		updated scheduleRequest information
Errors	DataValidationErrorException		one or more values invalid for this operation
	DoesNotExistException		scheduleRequestId not found
	InvalidParameterException		invalid scheduleRequestInfo or contextInfo
	MissingParameterException		scheduleRequestId, scheduleRequestInfo or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure 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	deleteScheduleRequest
Description	Removes scheduleRequest relationship between a person and a slot.
Parameters	String	scheduleRequestId	ScheduleRequest identifier
	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		scheduleRequestId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleRequestId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getTimeSlot
Description	Retrieves a TimeSlot
Parameters	String	timeSlotId	a unique Id of a TimeSlot
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TimeSlotInfo		the TimeSlot
Errors	DoesNotExistException		timeSlotId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		timeSlotId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getTimeSlotsByIds
Description	Retrieves a list of TimeSlots corresponding to the given list of TimeSlot Ids.
Parameters	StringList	timeSlotIds	list of TimeSlots to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TimeSlotInfoList		a list of TimeSlots
Errors	DoesNotExistException		a timeSlotId in list not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing timeSlotId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getTimeSlotIdsByType
Description	Retrieves a list of TimeSlot Ids by TimeSlot Type.
Parameters	String	timeSlotTypeKey	an identifier for an TimeSlot Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of TimeSlot identifiers matching timeSlotTypeKey or an empty list if none found
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		timeSlotTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getTimeSlotsByDaysAndStartTime
Description	Retrieves a list of TimeSlots by TimeSlot Type, days of week and start time. Parameter daysOfWeek follows the Java standard: Sunday=1 to Saturday=7
Parameters	String	timeSlotTypeKey	identifier for the given slot type
	IntegerList	daysOfWeek	days of the week of interest
	TimeOfDayInfo	startTime	start time of interest
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TimeSlotInfoList		a list of TimeSlots matching timeSlotTypeKey, daysOfWeek and startTime; empty list if none found
Errors	InvalidParameterException		invalid daysOfWeek, startTime or contextInfo
	MissingParameterException		timeSlotTypeKey, daysOfWeek, startTime or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getTimeSlotsByDaysAndStartTimeAndEndTime
Description	Retrieves a list of TimeSlots by TimeSlot Type, days of week, start time and end time. Parameter daysOfWeek follows the Java standard: Sunday=1 to Saturday=7
Parameters	String	timeSlotTypeKey	identifier for the given slot type
	IntegerList	daysOfWeek	days of the week of interest
	TimeOfDayInfo	startTime	start time of interest
	TimeOfDayInfo	endTime	end time of interest
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TimeSlotInfoList		a list of TimeSlots matching timeSlotTypeKey, daysOfWeek, startTime and endTime; empty list if none found
Errors	InvalidParameterException		invalid daysOfWeek, startTime, end time or contextInfo
	MissingParameterException		timeSlotTypeKey, daysOfWeek, startTime, endTime or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForTimeSlotIds
Description	Searches for TimeSlots based on the criteria and returns a list of TimeSlot 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 TimeSlot Ids
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForTimeSlots
Description	Searches for TimeSlots based on the criteria and returns a list of TimeSlots 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	TimeSlotInfoList		list of TimeSlots
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateTimeSlot
Description	Validates an TimeSlot. Depending on the value of validationType, this validation could be limited to tests on just the current TimeSlot and its directly contained sub-objects or expanded to perform all tests related to this TimeSlot. If an identifier is present for the TimeSlot (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the TimeSlot can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the object with the given data can be created.
Parameters	String	validationTypeKey	the identifier for the validation Type
	String	timeSlotTypeKey	the identifier for the timeSlot Type
	TimeSlotInfo	timeSlotInfo	detailed information about the timeSlot
	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		validationTypeKey, timeSlotId, not found
	InvalidParameterException		invalid timeSlotInfo or contextInfo
	MissingParameterException		validationTypeKey, timeSlotId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	createTimeSlot
Description	Creates a TimeSlot
Parameters	String	timeSlotTypeKey	the identifier for the timeSlot Type
	TimeSlotInfo	timeSlotInfo	detailed information about the timeSlot
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TimeSlotInfo		detailed information about the timeSlot
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		timeSlotId does not exist
	InvalidParameterException		invalid timeSlotInfo or contextInfo
	MissingParameterException		timeSlotId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at supplying information designated as read only

Back to Operations

Method	updateTimeSlot
Description	Updates a timeSlot.
Parameters	String	timeSlotId	identifier of the timeSlot to be updated
	TimeSlotInfo	timeSlotInfo	information about the object timeSlotInfo to be updated
	ContextInfo	contextInfo	context information containing the principalId and locale information about the caller of service operation
Return	TimeSlotInfo		updated timeSlot information
Errors	DataValidationErrorException		one or more values invalid for this operation
	DoesNotExistException		timeSlotId not found
	InvalidParameterException		invalid timeSlotInfo or contextInfo
	MissingParameterException		timeSlotId, timeSlotInfo or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure 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	deleteTimeSlot
Description	Removes timeslot relationship between a person and a slot.
Parameters	String	timeSlotId	TimeSlot identifier
	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		timeSlotId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		timeSlotId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	submitScheduleBatch
Description	Calls R25 in our implementation ... the scheduled results may not be available when this method returns. The method for scheduling ActivityOfferings may be in the CourseOffering service.
Parameters	String	scheduleBatchId	ScheduleRequest identifier
	ContextInfo	contextInfo	context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		ScheduleTransaction after submitting the Batch
Errors	DoesNotExistException		scheduleRequestId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleRequestId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	commitSchedules
Description	Saves the scheduleIds to the referenced objects
Parameters	String	scheduleBatchId	ScheduleBatch identifier
	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		scheduleBatchId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleBatchId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getValidDaysOfWeekByTimeSlotType
Description	Retrieves valid days of the week for the given slot type. Parameter daysOfWeek follows the Java standard: Sunday=1 to Saturday=7
Parameters	String	timeSlotTypeKey	identifier for the given slot type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	IntegerList		Days of the week for the slot type; empty list if none found
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		timeSlotTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleBatchesForScheduleTransaction
Description	Retrieves a list of ScheduleBatches associated with a ScheduleTransaction
Parameters	String	scheduleTransactionId	an identifier for a ScheduleBatch
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleBatchInfoList		a list of ScheduleTransaction identifiers matching scheduleTransactionTypeKey or an empty list if none found
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleTransactionTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleTransaction
Description	Retrieves a ScheduleTransaction
Parameters	String	scheduleTransactionId	a unique Id of a ScheduleTransaction
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleTransactionInfo		the ScheduleTransaction
Errors	DoesNotExistException		scheduleTransactionId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleTransactionId or contextInfo is missing or null
	OperationFailedException		unable to complete
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleTransactionsByIds
Description	Retrieves a list of ScheduleTransactions corresponding to the given list of ScheduleTransaction Ids.
Parameters	StringList	scheduleTransactionIds	list of ScheduleTransactions to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleTransactionInfoList		a list of ScheduleTransactions
Errors	DoesNotExistException		a scheduleTransactionId in list not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing scheduleTransactionId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleTransactionIdsByType
Description	Retrieves a list of ScheduleTransaction Ids by ScheduleTransaction Type.
Parameters	String	scheduleTransactionTypeKey	an identifier for a ScheduleTransaction Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of ScheduleTransaction identifiers matching scheduleTransactionTypeKey or an empty list if none found
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleTransactionTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleTransactionIdsByRefObject
Description	Retrieves a list of ScheduleTransaction Ids by Ref Object Type.
Parameters	String	refObjectType	an identifier for a ref object Type
	String	refObjectId	an
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of ScheduleTransaction identifiers matching scheduleTransactionTypeKey or an empty list if none found
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleTransactionTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleTransactionsByRefObject
Description	Retrieves a list of ScheduleTransaction objects by Ref Object Type.
Parameters	String	refObjectType	an identifier for a ref object Type
	String	refObjectId	an
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleTransactionInfoList		a list of ScheduleTransaction objects matching scheduleTransactionTypeKey or an empty list if none found
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleTransactionTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getScheduleTransactionsForScheduleBatch
Description	Retrieves a list of ScheduleTransactions associated with a ScheduleBatch
Parameters	String	scheduleBatchId	an identifier for a ScheduleBatch
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleTransactionInfoList		a list of ScheduleTransaction identifiers matching scheduleTransactionTypeKey or an empty list if none found
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleTransactionTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForScheduleTransactionIds
Description	Searches for ScheduleTransactions based on the criteria and returns a list of ScheduleTransaction 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 ScheduleTransaction Ids
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForScheduleTransactions
Description	Searches for ScheduleTransactions based on the criteria and returns a list of ScheduleTransactions 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	ScheduleTransactionInfoList		list of ScheduleTransactions
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateScheduleTransaction
Description	Validates a ScheduleTransaction. Depending on the value of validationType, this validation could be limited to tests on just the current ScheduleTransaction and its directly contained sub-objects or expanded to perform all tests related to this ScheduleTransaction. If an identifier is present for the ScheduleTransaction (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the ScheduleTransaction can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the object with the given data can be created.
Parameters	String	validationTypeKey	the identifier for the validation Type
	String	scheduleTransactionTypeKey	the identifier for the scheduleTransaction Type
	ScheduleRequestInfo	scheduleTransactionInfo	detailed information about the scheduleTransaction
	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		validationTypeKey, scheduleTransactionId, not found
	InvalidParameterException		invalid scheduleTransactionInfo or contextInfo
	MissingParameterException		validationTypeKey, scheduleTransactionId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	createScheduleTransaction
Description	Creates a ScheduleTransaction
Parameters	String	scheduleBatchId	the identifier for ScheduleBatch
	String	scheduleTransactionTypeKey	the identifier for the scheduleTransaction Type
	ScheduleTransactionInfo	scheduleTransactionInfo	detailed information about the scheduleTransaction
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ScheduleTransactionInfo		detailed information about the scheduleTransaction
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		scheduleTransactionId does not exist
	InvalidParameterException		invalid scheduleTransactionInfo or contextInfo
	MissingParameterException		scheduleTransactionId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at supplying information designated as read only

Back to Operations

Method	updateScheduleTransaction
Description	Updates a scheduleTransaction.
Parameters	String	scheduleTransactionId	identifier of the scheduleTransaction to be updated
	ScheduleTransactionInfo	scheduleTransactionInfo	information about the object scheduleTransactionInfo to be updated
	ContextInfo	contextInfo	context information containing the principalId and locale information about the caller of service operation
Return	ScheduleTransactionInfo		updated scheduleTransaction information
Errors	DataValidationErrorException		one or more values invalid for this operation
	DoesNotExistException		scheduleTransactionId not found
	InvalidParameterException		invalid scheduleTransactionInfo or contextInfo
	MissingParameterException		scheduleTransactionId, scheduleTransactionInfo or contextInfo is missing or null
	OperationFailedException		unable to complete Transaction
	PermissionDeniedException		an authorization failure 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	deleteScheduleTransaction
Description	Removes scheduleTransaction relationship between a person and a slot.
Parameters	String	scheduleTransactionId	ScheduleTransaction identifier
	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		scheduleTransactionId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		scheduleTransactionId or contextInfo is missing or null
	OperationFailedException		unable to complete Transaction
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	areTimeSlotsInConflict
Description	Tests if there is conflict amongst two time slots. Two TimeSlots are in conflict if they an overlap (even by a millisecond) their start and end times and share at least one weekday on which this occurs.
Parameters	String	timeSlot1Id	a unique Id of the first TimeSlot
	String	timeSlot2Id	a unique Id of the second TimeSlot
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	Boolean		true if there is a conflict (overlap) between the two timeslots, false otherwise
Errors	DoesNotExistException		either of the timeslot ids are not found
	InvalidParameterException		invalid timeslot ids or contextInfo
	MissingParameterException		timeSlot1Id, timeSlot2Id, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations