FeeService

• getFee
• getFeesByIds
• getFeeIdsByType
• getFeesByReference
• searchForFeeIds
• searchForFees
• validateFee
• createFee
• updateFee
• deleteFee

• EnrollmentFeeInfo
• QueryByCriteria
• ValidationResultInfo
• StatusInfo

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

Back to Operations

Method	getFeesByIds
Description	Retrieves a list of Fees from a list of Fee Ids. The returned list may be in any order and if duplicates Ids are supplied, a unique set may or may not be returned.
Parameters	StringList	feeIds	a list of Fee identifiers
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	EnrollmentFeeInfoList		a list of Fees
Errors	DoesNotExistException		a feeId in the list not found
	InvalidParameterException		contextInfo is invalid
	MissingParameterException		feeIds, an Id in feeIds, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

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

Back to Operations

Method	getFeesByReference
Description	Retrieves a list of Fees by the reference object.
Parameters	String	refObjectURI	the URI identifying the namespace of the reference Id
	String	refObjectId	the Id of the reference
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	EnrollmentFeeInfoList		a list of Fees for the reference object or an empty list is none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		missing refObjectURI, refObjectId, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForFeeIds
Description	Searches for Fees based on the criteria and returns a list of Fee identifiers which match the 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 Fee Ids 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	searchForFees
Description	Searches for Fees based on the criteria and returns a list of Fees which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	EnrollmentFeeInfoList		list of Fees 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	validateFee
Description	Validates a Fee. Depending on the value of validationType, this validation could be limited to tests on just the current Fee and its directly contained sub-objects or expanded to perform all tests related to this Fee. If an identifier is present for the Fee (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the Fee 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	feeTypeKey	the identifier for the fee Type
	EnrollmentFeeInfo	feeInfo	the Fee information 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 feeTypeKey is not found
	InvalidParameterException		feeInfo or contextInfo is not valid
	MissingParameterException		validationTypeKey, feeTypeKey, feeInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	createFee
Description	Creates a new Fee. The Fee Id, Type, and Meta information may nogt be set in the supplied data.
Parameters	String	feeTypeKey	the identifier for the Type of the new Fee
	EnrollmentFeeInfo	feeInfo	the data with which to create the Fee
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	EnrollmentFeeInfo		the new Fee
Errors	DataValidationErrorException		supplied data is invalid
	InvalidParameterException		feeInfo or contextInfo is not valid
	MissingParameterException		feeTypeKey, feeInfo 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	updateFee
Description	Updates an existing Fee. The Fee Id, Type, and Meta information may not be changed.
Parameters	String	feeId	the identifier for the Fee to be updated
	EnrollmentFeeInfo	feeInfo	the new data for the Fee
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	EnrollmentFeeInfo		the updated Fee
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		feeId not found
	InvalidParameterException		feeInfo or contextInfo is not valid
	MissingParameterException		feeId, feeInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at changing information designated as read-only
	VersionMismatchException		optimistic locking failure or the action was attempted on an out of date version

Back to Operations

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

Back to Operations