home

Fee

Name Fee
Usage CourseOfferingService
CourseOffering
Type Complex

Description

Information about a fee related to an learning unit

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
feeType Fee Type String A code that identifies the type of the fee. For example: Lab Fee or Tuition Fee or CMF for Course Materials Fee.
From a program perspective it may be an application fee.		     One No  
rateType Rate Type String Indicates the structure and interpretation of the fee amounts, i.e. Fixed, Variable, Multiple.     One No  
feeAmounts Fee Amounts CurrencyAmountList The amount or amounts associated with the fee. The number fee amounts and interpretation depends on the rate type.     Many No  
descr Description RichText Narrative description of the Fee.     One No  
attributes Dynamic Attributes AttributeList List of dynamic attributes, each holding a key-value pair that
can be configured to hold additional information for an
implementing institution.

Note: the key may be repeated more than once to simulate a list
of values.		     Many No  
meta Create/Update meta info Meta Create and last update info for the structure. This is optional
and treated as read only since the data is set by the internals
of the service during maintenance operations.

Contains audit trail information about the creation and last
update of this object Also contains the version ind used for
optimistic locking.

Attempts to set or update should result in a ReadOnlyException
being thrown.		 Required on updates Read only One No  
id Unique Id String The system assigned unique id to identify this Object.
Could be implemented as as sequence number or as a UUID.

Attempts to set this value on creates should result in a ReadOnlyException being thrown

An Id:

  • An id is used when the actual value is unimportant and can therefore be a large hex value for example
  • An id value might be 23b9ca9bd203df902
  • An Id is never intended to be used directly by an end user.
  • Ids are assumed to be of different values in different KS implementations
  • Id values are generated by the service implementations
  • Id values are never expected to be used in Configuration or Application code
 Required on updates Read only One No