AcademicCalendarService

Name	AcademicCalendar
Version	1.0 (Dev)
Included Services	StateService, TypeService, DataDictionaryService

Academic Calendar Service Description and Assumptions.

This service manages Academic Calendars. An Academic Calendar is
related to a credential program type and contains Terms. The Terms
are managed as nested objects inside the Academic Calendar at this
level.

Key Dates are mapped to Terms but are managed through the service
independent of the Term. This is to allow a reference to a Term
that does not retrieve all the key date information that may relate
to the Term.

Terms may be nested at this level. A Term may contain another Term
and each of these sub-Terms may have their own key
dates. Convenience service methods exist to query all the key dates
for an Academic Calendar or parent Term.

An Academic Calendar also has a Campus Calendar. The Campus
Calendar has a campus location, and include the key dates and
holidays that are specific to a campus. The same Campus Calendar
can be used for multiple Academic Calendars.

Main Message Structures

Method getAcademicCalendar

Description Retrieves the details of a single Academic Calendar by an
academic calendar key.

Parameters String academicCalendarKey Unique key of the Academic Calendar to be retrieved

ContextInfo context Context information containing the principalId
and locale information about the caller of service
operation

Return AcademicCalendarInfo the details of the Academic Calendar requested

Errors DoesNotExistException academicCalendarKey not found

InvalidParameterException invalid academicCalendarKey

MissingParameterException missing academicCalendarKey

OperationFailedException unable to complete request

PermissionDeniedException authorization failure

Method	getAcademicCalendar
Description	Retrieves the details of a single Academic Calendar by an academic calendar key.
Parameters	String	academicCalendarKey	Unique key of the Academic Calendar to be retrieved
ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	AcademicCalendarInfo	the details of the Academic Calendar requested
Errors	DoesNotExistException	academicCalendarKey not found
InvalidParameterException	invalid academicCalendarKey
MissingParameterException	missing academicCalendarKey
OperationFailedException	unable to complete request
PermissionDeniedException	authorization failure

Method	getAcademicCalendarsByKeyList
Description	Retrieves a list Academic Calendars corresponding to a list of academic calendar keys.
Parameters	StringList	academicCalendarKeyList	list of unique keys of the Academic Calendar to be retrieved
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	AcademicCalendarInfoList		a list of Academic Calendars
Errors	DoesNotExistException		???
	InvalidParameterException		invalid academicCalendarKey in list
	MissingParameterException		missing academicCalendarKeyList
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getAcademicCalendarKeysByType
Description	Retrieves a list of Academic Calendar Keys by Type.
Parameters	String	academicCalendarTypeKey	a Type of Academic Calendar to be retrieved
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Academic Calendars of the given Type
Errors	InvalidParameterException		invalid academicCalendarTypeKey
	MissingParameterException		missing academicCalendarTypeKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getAcademicCalendarsByYear
Description	Retrieves a list of Academic Calendars that pertain to the given year.
Parameters	Integer	year	???
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	AcademicCalendarInfoList		a list of Academic Calendars
Errors	InvalidParameterException		invalid year
	MissingParameterException		missing year
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getAcademicCalendarsByCredentialProgramType
Description	Retrieves a list of Academic Calendars mapped to a credential program type.
Parameters	String	credentialProgramTypeKey	a Type of a credential program
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	AcademicCalendarInfoList		a list of Academic Calendars
Errors	InvalidParameterException		invalid credentialProgramTypeKey
	MissingParameterException		missing credentialProgramTypeKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	validateAcademicCalendar
Description	Validates an academic calendar. 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
	AcademicCalendarInfo	academicCalendarInfo	the academic calendar 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

Method	createAcademicCalendar
Description	Creates a new Academic Calendar.
Parameters	String	academicCalendarKey	the key of the Academic Calendar to be created
	AcademicCalendarInfo	academicCalendarInfo	Details of the Academic Calendar to be created
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	AcademicCalendarInfo		the details of the Academic Calendar just created
Errors	AlreadyExistsException		the Academic Calendar being created already exists
	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

Method	updateAcademicCalendar
Description	Updates an existing Academic Calendar.
Parameters	String	academicCalendarKey	Key of Academic Calendar to be updated
	AcademicCalendarInfo	academicCalendarInfo	Details of updates to the Academic Calendar being updated
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	AcademicCalendarInfo		the details of Academic Calendar just updated
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		the Academic Calendar 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.

Method	deleteAcademicCalendar
Description	Deletes an existing Academic Calendar.
Parameters	String	academicCalendarKey	the key of the Academic Calendar to be deleted
Parameters	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 Academic Calendar does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	copyAcademicCalendar
Description	Copy an Academic Calendar. The associated Terms and key datess are also copied and related to this new calendar. This copy operation allows for a calendar template to be created from an existing calendar in which the dates of the Terms and Key Dates will be updated. Currently, this method does not perform any date transformations on the Terms and key dates (Labor Day has a new date). A rollover process needs to make a copy of a calendar and set the new dates for the new year.
Parameters	String	academicCalendarKey	the key of the Academic Calendar to be copied
	String	newAcademicCalendarKey	the key of the new copy of the Academic Calendar
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	AcademicCalendarInfo		status of the operation (success, failed)
Errors	AlreadyExistsException		newAcademicCalendarKey already exists
	DoesNotExistException		the Academic Calendar does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getAcademicCalendarData
Description	Generates calendaring data for the Terms and key dates in an Academic Calendar. The format of the data is specified by the calendarDataFormatType. An example of such a type is VCALENDAR.
Parameters	String	academicCalendarKey	the key of the Academic Calendar to be retrieved
	String	calendarDataFormatTypeKey	the type of format
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	String		status of the operation (success, failed)
Errors	DoesNotExistException		the Academic Calendar or format type does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getCampusCalendar
Description	Retrieves the details of a single Campus Calendar by an campus calendar key.
Parameters	String	campusCalendarKey	Unique key of the Campus Calendar to be retrieved
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	CampusCalendarInfo		the details of the Campus Calendar requested
Errors	DoesNotExistException		campusCalendarKey not found
	InvalidParameterException		invalid campusCalendarKey
	MissingParameterException		missing campusCalendarKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getCampusCalendarsByKeyList
Description	Retrieves a list Campus Calendars corresponding to a list of campus calendar keys.
Parameters	StringList	campusCalendarKeyList	list of unique keys of the Campus Calendar to be retrieved
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	CampusCalendarInfoList		a list of Campus Calendars
Errors	DoesNotExistException		???
	InvalidParameterException		invalid campusCalendarKey in list
	MissingParameterException		missing campusCalendarKeyList
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getCampusCalendarKeysByType
Description	Retrieves a list of Campus Calendars by Type.
Parameters	String	campusCalendarTypeKey	a Type of Campus Calendar to be retrieved
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Campus Calendars of the given Type
Errors	InvalidParameterException		invalid campusCalendarTypeKey
	MissingParameterException		missing campusCalendarTypeKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getCampusCalendarsByYear
Description	Retrieves a list of Campus Calendars that pertain to the given year.
Parameters	Integer	year	???
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	CampusCalendarInfoList		a list of Campus Calendars
Errors	InvalidParameterException		invalid year
	MissingParameterException		missing year
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	validateCampusCalendar
Description	Validates a campus calendar. 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 campus calendar and a record is found for that identifier, the validation checks if the campus 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
	CampusCalendarInfo	campusCalendarInfo	the campus calendar 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, campusCalendarInfo
	MissingParameterException		missing validationTypeKey, campusCalendarInfo
	OperationFailedException		unable to complete request

Method	createCampusCalendar
Description	Creates a new Campus Calendar.
Parameters	String	campusCalendarKey	the key of the Campus Calendar to be created
	CampusCalendarInfo	campusCalendarInfo	Details of the Campus Calendar to be created
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	CampusCalendarInfo		the details of the Campus Calendar just created
Errors	AlreadyExistsException		the Campus Calendar being created already exists
	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

Method	updateCampusCalendar
Description	Updates an existing Campus Calendar.
Parameters	String	campusCalendarKey	Key of Campus Calendar to be updated
	CampusCalendarInfo	campusCalendarInfo	Details of updates to the Campus Calendar being updated
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	CampusCalendarInfo		the details of Campus Calendar just updated
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		the Campus Calendar 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.

Method	deleteCampusCalendar
Description	Deletes an existing Campus Calendar.
Parameters	String	campusCalendarKey	the key of the Campus Calendar to be deleted
Parameters	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 Campus Calendar does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getTerm
Description	Retrieves the details of a single Term by a term key.
Parameters	String	termKey	Unique key of the Term to be retrieved
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	TermInfo		the details of the Term requested
Errors	DoesNotExistException		termKey not found
	InvalidParameterException		invalid termKey
	MissingParameterException		missing termKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getTermsByKeyList
Description	Retrieves a list Terms corresponding to a list of terms keys.
Parameters	StringList	termKeyList	list of unique keys of the Term to be retrieved
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	TermInfoList		a list of Terms
Errors	DoesNotExistException		???
	InvalidParameterException		invalid termKey in list
	MissingParameterException		missing termKeyList
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getTermKeysByType
Description	Retrieves a list of Terms by Type.
Parameters	String	termTypeKey	a Type of Term to be retrieved
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Terms of the given Type
Errors	InvalidParameterException		invalid termTypeKey
	MissingParameterException		missing termTypeKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getKeyDate
Description	Retrieves the details of a single key date by a key date key.
Parameters	String	keyDateKey	Unique key of the key date to be retrieved
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	KeyDateInfo		the details of the key date requested
Errors	DoesNotExistException		keyDateKey not found
	InvalidParameterException		invalid keyDateKey
	MissingParameterException		missing keyDateKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getKeyDatesByKeyList
Description	Retrieves a list of key dates corresponding to a list of key date keys.
Parameters	StringList	keyDateKeyList	list of unique keys of the key date to be retrieved
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	KeyDateInfoList		a list of key dates
Errors	DoesNotExistException		???
	InvalidParameterException		invalid keyDateKey in list
	MissingParameterException		missing keyDateKeyList
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getKeyDateKeysByType
Description	Retrieves a list of key dates by Type.
Parameters	String	keyDateTypeKey	a Type of key date to be retrieved
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of key dates of the given Type
Errors	InvalidParameterException		invalid key dateTypeKey
	MissingParameterException		missing keyDateTypeKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getKeyDatesForAcademicCalendar
Description	Retrieves a list of key dates for an academic calendar. The dates include all key dates mapped to any terms, sub terms, or campus calendars.
Parameters	String	academicCalendarKey	???
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	KeyDateInfoList		a list of key dates
Errors	DoesNotExistException		???
	InvalidParameterException		invalid academicCalendarKey
	MissingParameterException		missing academicCalendarKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getKeyDatesForTerm
Description	Retrieves a list of key dates immediately mapped to a Term.
Parameters	String	termKey	???
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	KeyDateInfoList		a list of key dates
Errors	DoesNotExistException		???
	InvalidParameterException		invalid termKey
	MissingParameterException		missing termKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	getAllKeyDatesForTerm
Description	Retrieves a list of key dates for a Term. The dates include all key dates mapped to any nested terms.
Parameters	String	termKey	???
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	KeyDateInfoList		a list of key dates
Errors	DoesNotExistException		???
	InvalidParameterException		invalid termKey
	MissingParameterException		missing termKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	validateKeyDate
Description	Validates a key date. 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 key date and a record is found for that identifier, the validation checks if the key date 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
	KeyDateInfo	keyDateInfo	the key date 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, keyDateInfo
	MissingParameterException		missing validationTypeKey, keyDateInfo
	OperationFailedException		unable to complete request

Method	createKeyDateForTerm
Description	Creates a new Key Date for a Term.
Parameters	String	termKey	a key for a Term to which this date is mapped
	String	keyDateKey	the key of the Key Date to be created
	KeyDateInfo	keyDateInfo	Details of the Key Date to be created
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	KeyDateInfo		the details of the Key Date just created
Errors	AlreadyExistsException		the Key Date being created already exists
	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

Method	createKeyDateForCampusCalendar
Description	Creates a new Key Date for a Campus Calendar.
Parameters	String	campusCalendarKey	a key for a Term to which this key date is mapped
	String	keyDateKey	the key of the Key Date to be created
	KeyDateInfo	keyDateInfo	Details of the Key Date to be created
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	KeyDateInfo		the details of the Key Date just created
Errors	AlreadyExistsException		the Key Date being created already exists
	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