AtpService

• getAtp
• getAtpsByIds
• getAtpIdsByType
• getAtpsByCode
• getAtpsByDate
• getAtpsByDateAndType
• getAtpsByDates
• getAtpsByDatesAndType
• getAtpsByStartDateRange
• getAtpsByStartDateRangeAndType
• searchForAtpIds
• searchForAtps
• validateAtp
• createAtp
• updateAtp
• deleteAtp
• getAtpAtpRelation
• getAtpAtpRelationsByIds
• getAtpAtpRelationIdsByType
• getAtpAtpRelationsByAtp
• getAtpAtpRelationsByAtps
• getAtpAtpRelationsByTypeAndAtp
• searchForAtpAtpRelationIds
• searchForAtpAtpRelations
• validateAtpAtpRelation
• createAtpAtpRelation
• updateAtpAtpRelation
• deleteAtpAtpRelation
• getMilestone
• getMilestonesByIds
• getMilestoneIdsByType
• getMilestonesByDates
• getMilestonesForAtp
• getMilestonesByDatesForAtp
• getMilestonesByTypeForAtp
• getImpactedMilestones
• searchForMilestoneIds
• searchForMilestones
• validateMilestone
• createMilestone
• updateMilestone
• deleteMilestone
• calculateMilestone
• addMilestoneToAtp
• removeMilestoneFromAtp

• AtpInfo
• QueryByCriteria
• ValidationResultInfo
• StatusInfo
• AtpAtpRelationInfo
• MilestoneInfo

Method	getAtp
Description	Retrieves a single Academic Time Period by ATP id.
Parameters	String	atpId	the identifier of the Academic Time Period to be retrieved
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpInfo		the Academic Time Period requested
Errors	DoesNotExistException		atpId is not found
	InvalidParameterException		contextInfo not valid
	MissingParameterException		atpId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getAtpsByIds
Description	Retrieves a list of Academic Time Periods from a list of ATP Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.
Parameters	StringList	atpIds	a list of ATP Ids
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpInfoList		a list of ATPs
Errors	DoesNotExistException		an atpId in the list not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		atpIds, an id in atpIds, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getAtpIdsByType
Description	Retrieves a list of Academic Time Periods by ATP Type.
Parameters	String	atpTypeKey	an identifier for the ATP type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Academic Time Period Ids matching atpTypeKey or an empty list if none found
Errors	InvalidParameterException		contextInfo is invalid
	MissingParameterException		atpTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getAtpsByCode
Description	Gets a list of ATPss by Code. Typically, an ATP Code is unique.
Parameters	String	code	an ATP Code
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpInfoList		a list of ATPs with the given ATP Code
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		code or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getAtpsByDate
Description	Retrieves a list of Academic Time Periods where the supplied date falls within the start and end date of the ATP inclusive of the date.
Parameters	Date	date	a date
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpInfoList		a list of Academic Time Periods that contain the supplied date
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		date or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getAtpsByDateAndType
Description	Retrieves a list of Academic Time Periods where the supplied date falls within the start and end date of the ATP, inclusive of the date, and whose type matches the specified ATP type.
Parameters	Date	date	a date
	String	atpTypeKey	an identifier for an ATP Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpInfoList		a list of Academic Time Periods of the ATP Type that contain the supplied date
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		date, atpTypeKey, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getAtpsByDates
Description	Retrieves a list of Academic Time Periods that are totally contained within the supplied dates. The entire ATP falls within the supplied dates inclusive of the dates.
Parameters	Date	startDate	start date of range
	Date	endDate	end date of range
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpInfoList		a list of Academic Time Periods within the supplied dates
Errors	InvalidParameterException		contextInfo is not valid or the startDate is greater than the endDate
	MissingParameterException		startDate, endDate, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getAtpsByDatesAndType
Description	Retrieves the list of Academic Time Periods that are totally contained within the supplied dates and whose type matches the supplied ATP type. The entire ATP falls within the supplied dates inclusive of the dates.
Parameters	Date	startDate	start date of range
	Date	endDate	end date of range
	String	atpTypeKey	an identifier for an ATP Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpInfoList		a list of Academic Time Periods of the supplied ATP Type within the supplied dates
Errors	InvalidParameterException		contextInfo is not valid or startDate is greater than endDate
	MissingParameterException		startDate, endDate, atpTypeKey, or conetxtInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getAtpsByStartDateRange
Description	Retrieves a list of Academic Time Periods whose start dates fall within the supplied date range, inclusive of the start and end dates on the supplied range.
Parameters	Date	dateRangeStart	start date of range
	Date	dateRangeEnd	end date of range
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpInfoList		a list of Academic Time Periods with start dates within the supplied dates
Errors	InvalidParameterException		contextInfo is not valid or startDate is greater than endDate
	MissingParameterException		datRangeStart, dateRangeEnd, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getAtpsByStartDateRangeAndType
Description	Retrieves the list of Academic Time Periods whose start dates fall within the supplied date range, inclusive of the start and end dates on the range and whose type matches the specified ATP Type.
Parameters	Date	dateRangeStart	start date of range
	Date	dateRangeEnd	end date of range
	String	atpTypeKey	an identifier for an ATP Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpInfoList		a list of Academic Time Periods with start dates within the supplied dates and of the given ATP Type
Errors	InvalidParameterException		contextInfo is not valid or dateRangeStart is greater than dateRangeEnd
	MissingParameterException		dateRangeStart, dateRangeEnd, atpTypeKey, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForAtpIds
Description	Searches for Academic Time Period Ids that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StringList		list of ATP identifiers matching the criteria
Errors	InvalidParameterException		criteria or contextInfo is not valid
	MissingParameterException		criteria or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForAtps
Description	Searches for Academic Time Periods that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpInfoList		list of ATPs matching the criteria
Errors	InvalidParameterException		criteria or contextInfo is not valid
	MissingParameterException		criteria or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	validateAtp
Description	Validates an Academic Time Period. 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 ATP. If an identifier is present for the ATP (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the ATP can be shifted to the new values. If a an identifier is not present or a record does not exist, the validation checks if the ATP with the given data can be created.
Parameters	String	validationTypeKey	the identifier for the validation Type
	String	atpTypeKey	the identifier for the ATP Type to be validated
	AtpInfo	atpInfo	the identifier for the ATP to be validated
	ContextInfo	contextInfo	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 or atpTypeKey is not found
	InvalidParameterException		atpInfo or contextInfo is not valid
	MissingParameterException		validationTypeKey, atpTypeKey atpInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	createAtp
Description	Creates a new Academic Time Period. The ATP Type and Meta information may not be set in the supplied data object.
Parameters	String	atpTypeKey	the type of the atp
	AtpInfo	atpInfo	the data with which to create the ATP
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpInfo		the new ATP
Errors	DataValidationErrorException		supplied data is invalid
	InvalidParameterException		atpInfo or contextInfo is not valid
	MissingParameterException		atpId, atpTypeKey, atpInfo, 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	updateAtp
Description	Updates an existing Academic Time Period. The ATP id, Type, and Meta information may not be changed.
Parameters	String	atpId	the identifier for the ATP to be updated
	AtpInfo	atpInfo	the new data for the ATP
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpInfo		the updated ATP
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		atpId is not found
	InvalidParameterException		atpInfo or contextInfo is not valid
	MissingParameterException		atpId, atpInfo, 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		an optimistic locking failure or the action was attempted on an out of date version

Back to Operations

Method	deleteAtp
Description	Deletes an existing Academic Time Period.
Parameters	String	atpId	the identifier for the ATP to be deleted
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		the status of the operation. This must always be true.
Errors	DoesNotExistException		atpId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		atpId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getAtpAtpRelation
Description	Retrieves a single AtpAtpRelation by AtpAtpRelation Id.
Parameters	String	atpAtpRelationId	the identifier for the AtpAtpRelation to be retrieved
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpAtpRelationInfo		the AtpAtpRelation requested
Errors	DoesNotExistException		atpAtpRelationId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		atpAtpRelationId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getAtpAtpRelationsByIds
Description	Retrieves a list of AtpAtpRelations from a list of AtpAtpRelation Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.
Parameters	StringList	atpAtpRelationIds	a list of AtpAtpRelation identifiers
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpAtpRelationInfoList		a list of AtpAtpRelations
Errors	DoesNotExistException		an atpAtpRelationId in the list not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		atpAtpRelationIds, an atpAtpRelationId in the atpAtpRelationIds, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

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

Back to Operations

Method	getAtpAtpRelationsByAtp
Description	Retrieves all AtpAtpRelations to the given ATP independent of which side of the relationship the ATP resides.
Parameters	String	atpId	the identifier for the ATP
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpAtpRelationInfoList		a list of AtpAtprelations to the given ATP or an empty list if none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		atpId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getAtpAtpRelationsByAtps
Description	Retrieves all AtpAtpRelations between the given ATPs.
Parameters	String	atpId	the identifier for the ATP
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpAtpRelationInfoList		a list of AtpAtpRelations between the given ATPs or an empty list if none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		atpId, atpPeerId, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getAtpAtpRelationsByTypeAndAtp
Description	Retrieves a list of AtpAtpRelations of the specified AtpAtpRelationType for an ATP. (these parameters are backwards).
Parameters	String	atpId	the identifier for an ATP
	String	atpAtpRelationTypeKey	the identifier for an AtpAtpRelationType
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpAtpRelationInfoList		a list of AtpAtpRelations of the specified AtpAtpRelationType for the given ATP or an empty list if none found
Errors	InvalidParameterException		contextInfo is notvalid
	MissingParameterException		atpId, atpAtpRelationTypeKey, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForAtpAtpRelationIds
Description	Searches for AtpAtpRelations that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of AtpAtpRelation identifiers matching the criteria
Errors	InvalidParameterException		criteria or contextInfo is not valid
	MissingParameterException		criteria or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForAtpAtpRelations
Description	Searches for AtpAtpRelations that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpAtpRelationInfoList		a list of AtpAtpRelations matching the criteria
Errors	InvalidParameterException		contextInfo is invalid
	MissingParameterException		criteria or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	validateAtpAtpRelation
Description	Validates an AtpAtpRelation. Depending on the value of validationType, this validation could be limited to tests on just the current AtpAtpRelation and its directly contained sub-objects or expanded to perform all tests related to this AtpAtpRelation. If an identifier is present for the AtpAtpRelation (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the AtpAtpRelation can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, the validation checks if the object with the given data can be created.
Parameters	String	validationTypeKey	the identifier for the validation Type
	String	atpId	the identifier for an ATP
	String	atpPeerId	a the identifier for the ATP peer
	String	atpAtpRelationTypeKey	the identifier for the AtpAtpRelation Type
	AtpAtpRelationInfo	atpAtpRelationInfo	the AtpAtpRelation to be validated
	ContextInfo	contextInfo	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, atpId, atpPeerId, or atpAtpRelationTypeKey is not found
	InvalidParameterException		atpAtpRelationInfo or contextInfo is not valid
	MissingParameterException		validationTypeKey, atpId, atpPeerId, atpAtpRelationTypeKey, atpAtpRelationInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createAtpAtpRelation
Description	Creates a new AtpAtpRelation. The AtpAtpRelation Id, Type, ATP Ids, and Meta information may not be set in the supplied data.
Parameters	String	atpId	a peer of the relationship
	String	relatedAtpId	a peer of the relationship
	String	atpAtpRelationTypeKey	type of relationship between the two
	AtpAtpRelationInfo	atpAtpRelationInfo	the relationship to be created
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpAtpRelationInfo		the new AtpAtpRelation
Errors	DoesNotExistException		atpId, atpPeerId, or atpAtpRelationTypeKey is not found
	DataValidationErrorException		supplied data is invalid
	InvalidParameterException		atpAtpRelationInfo or contextInfo is not valid
	MissingParameterException		atpId, atpPeerId, atpAtpRelationTypeKey, atpAtpRelationInfo, 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	updateAtpAtpRelation
Description	Updates an ATP Milestone Relationship. The AtpAtpRelation Id, Type, ATP Ids, and Meta information may not be changed.
Parameters	String	atpAtpRelationId	the identifier for the AtpAtpRelation updated
	AtpAtpRelationInfo	atpAtpRelationInfo	the new data for the AtpAtpRelation
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	AtpAtpRelationInfo		the updated AtpAtpRelation
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		atpAtpRelationId is not found
	InvalidParameterException		atpAtpRelationInfo or contextInfo is not valid
	MissingParameterException		atpAtpRelationId, atpAtpRelationInfo, 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	deleteAtpAtpRelation
Description	Deletes an existing AtpAtpRelation.
Parameters	String	atpAtpRelationId	the identifier for the AtpAtpRelation to be deleted
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the delete operation. This must always be true.
Errors	DoesNotExistException		atpAtprelationId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		atpAtpRelationId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getMilestone
Description	Retrieves a single Milestone by a Milestone Id.
Parameters	String	milestoneId	the identifier for the Milestone to be retrieved
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	MilestoneInfo		the Milestone requested
Errors	DoesNotExistException		milestoneId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		milestoneId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getMilestonesByIds
Description	Retrieves a list of Milestones from a list of Milestone Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.
Parameters	StringList	milestoneIds	a list of Milestone identifiers
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	MilestoneInfoList		a list of Milestones
Errors	DoesNotExistException		a milestoneId in the list was not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		milestoneIds, an Id in the milestoneIds, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

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

Back to Operations

Method	getMilestonesByDates
Description	Retrieves a list of Milestones that fall within a specified set of dates inclusive of the dates. If the milestone is a date range then it should be selected if it overlaps any part of the specified start and end dates. Should follow these rules for storing and querying https://wiki.kuali.org/display/STUDENT/Storing+and+Querying+Milestone+Dates
Parameters	Date	startDate	start of date range
	Date	endDate	end of date range
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	MilestoneInfoList		a list of Milestones that fall within this set of dates
Errors	InvalidParameterException		contextInfo is not valid or startDate is greater than endDate
	MissingParameterException		startDate, endDate, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getMilestonesForAtp
Description	Retrieves a list of Milestones for a specified Academic Time Period.
Parameters	String	atpId	an identifier for an Academic Time Period
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	MilestoneInfoList		a list of Milestones for the ATP or an empty list if none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		atpId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getMilestonesByDatesForAtp
Description	Retrieves a list of Milestones for a specified Academic Time Period that fall within a specified set of dates inclusive of the dates. If the milestone is a date range then it should be selected if it overlaps any part of the specified start and end dates. Should follow these rules for storing and querying https://wiki.kuali.org/display/STUDENT/Storing+and+Querying+Milestone+Dates
Parameters	String	atpId	an identifier for an ATP
	Date	startDate	start of date range
	Date	endDate	end of date range
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	MilestoneInfoList		a list of Milestones for the ATP in the specified date range or an empty list if none found
Errors	InvalidParameterException		contextInfo is not valid or startDate is greater than end date
	MissingParameterException		atpId, startDate, endDate, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getMilestonesByTypeForAtp
Description	Retrieves a list of Milestones of a specified Milestone Type for an Acdemic Time Period.
Parameters	String	atpId	an identifier for an ATP
	String	milestoneTypeKey	an identifier for a Milestone Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	MilestoneInfoList		a list of Milestones of the Milestone Type for the ATP or an empty list if none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		atpId, milsetoneTypeKey, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getImpactedMilestones
Description	Gets a list of Milestones impacted by a change to a given Milestone. A milestone can be a "relative" milsetone where its dates are calculated from another milestone. The calculation itself is a rule attched to the Milestone Type. This method queries to see what other Milestones use the given Milestone as an anchor.
Parameters	String	milestoneId	an identifier for a Milestone
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	MilestoneInfoList		a list of Milestones impacted by the given Milestone
Errors	DoesNotExistException		milestoneId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		milestoneId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForMilestoneIds
Description	Searches for Milestones that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Milestone identifiers matching the criteria
Errors	InvalidParameterException		criteria or contextInfo is not valid
	MissingParameterException		criteria or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForMilestones
Description	Searches for Milestones that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	MilestoneInfoList		a list of Milestones matching the criteria
Errors	InvalidParameterException		criteria or contextInfo is not valid
	MissingParameterException		criteria or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	validateMilestone
Description	Validates a Milestone. Depending on the value of validationType, this validation could be limited to tests on just the current Milestone and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the Milestone (and/or one of its contained sub-obejcts) and a record is found for that identifier, the validation checks if the Milestone can be shifted 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
	MilestoneInfo	milestoneInfo	the milestone to be validated
	ContextInfo	contextInfo	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 or milestoneTypeKey is not found
	InvalidParameterException		milestoneInfo or contextInfo is not valid
	MissingParameterException		validationTypeKey, milestoneTypeKey, milestoneInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	createMilestone
Description	Create a new Milestone. The Milestone Id, Type, and Meta information may not be set in the supplied data object.
Parameters	String	milestoneTypeKey	identifies the type of this milestone
	MilestoneInfo	milestoneInfo	the data with which to create the Milestone
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	MilestoneInfo		the new Milestone
Errors	DataValidationErrorException		supplied data is invalid
	InvalidParameterException		milestoneInfo or contextInfo is not valid
	MissingParameterException		milestoneTypeKey, milestoneInfo, 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	updateMilestone
Description	Updates an existing Milestone. The Milestone Id, Type, and Meta information may not be changed.
Parameters	String	milestoneId	the identifier for the Milestone to be updated
	MilestoneInfo	milestoneInfo	the new data for the Milestone
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	MilestoneInfo		the updated Milestone
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		milestoneId is not found
	InvalidParameterException		milestoneInfo or contextInfo is not valid
	MissingParameterException		milestoneId, milestoneInfo, 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		an optimistic locking failure or the action was attempted on an out of date version

Back to Operations

Method	deleteMilestone
Description	Deletes an existing Milestone.
Parameters	String	milestoneId	the identifier for the Milestone to be deleted
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the delete operation. This must always be true.
Errors	DoesNotExistException		milestoneId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		milestoneId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	calculateMilestone
Description	Calculates the dates in the Milestone based on a rule attached to the Milestone Type. If there is no rule available for the Type of the given Milestone, then no changes to the Milestone occur.
Parameters	String	milestoneId	an identifier for a Milestone
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	MilestoneInfo		the Milestone with the calculated dates
Errors	DoesNotExistException		milestoneId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		milestoneId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	addMilestoneToAtp
Description	Adds a Milestone to an ATP.
Parameters	String	milestoneId	an identifier for a Milestone
	String	atpId	an identifier for an ATP
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the mapping operation. This must always be true.
Errors	AlreadyExistsException		milestoneId is already related to atpId
	DoesNotExistException		milestoneId or atpId is not found
	InvalidParameterException		contextInfo is not valud
	MissingParameterException		milestoneId, atpId, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	removeMilestoneFromAtp
Description	Removes a Milestone from an ATP.
Parameters	String	milestoneId	an identifier for a Milestone
	String	atpId	an identifier for an ATP
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the unmapping operation. This must always be true.
Errors	DoesNotExistException		milestoneId or atpId is not found or milestoneId is not related to atpId
	InvalidParameterException		contextInfo is not valud
	MissingParameterException		milestoneId, atpId, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations