home

RegistrationGroup

Name RegistrationGroup
Usage CourseOfferingService
RegGroupRegistrationInfo
Type Complex

Description

Registration group are the physical entities that students will try to register into. A RegistrationGroup is used to group
individual activity offerings based on the canonical format.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
activityOfferingIds ActivityOffering Ids StringList Activity Offerings for the registration group. This list should be constrained by the canonical
format and the activity offerings listed in the course offering		     Many No maps to the lui Ids of the activityOffering retrieved from luiluirelation of type activityOffering to registration group
courseOfferingId CourseOffering Id String Course offering for this registration group Required Read only on updates One No maps to the lui Id of the courseOffering retrieved from luiluirelation of type courseoffering to registration group
formatId Format Id String Canonical format to which this registration group belong to.     One No this maps the the version dependent id of the format clu. Stored as cluId in Lui
registrationCode Registration Code String Uniquely identifies an instance of the course for the purposes of registration     One No maps to lui code in Lui
isHonorsOffering Is Honors Offering Boolean Indicates that the entire course offering is an Honors Course     One No  
maximumEnrollment Maximum Enrollment Integer Total maximum number of "seats" or enrollment slots that can be filled for the offering. Constrained by smallest activity enrollment     One No maps to Lui.maximumEnrollment
minimumEnrollment Minimum Enrollment Integer Total minimum number of seats that must be filled for the offering not to be canceled. Constrained by smallest activity enrollment     One No maps to Lui.minimumEnrollment
hasWaitlist Has Waitlist Boolean Indicates whether a RegistrationGroup has a waitlist     One No maps to Lui.hasWaitlist
waitlistTypeKey Waitlist Type String Indicates the type of waitlist as it relates to processing students on and off     One No maps to Lui.waitlistTypeKey
waitlistMaximum Waitlist Maximum Integer Maximum number of students to be allowed on the wait list     One No maps to Lui.waitlistMaximum
isWaitlistCheckinRequired Is Waitlist Checkin Required Boolean Indicates if the waitlist requires checkin     One No maps to Lui.isWaitlistCheckinRequired
waitlistCheckinFrequency Waitlist Checkin Frequency TimeAmount Frequency for the waitlist checkin     One No maps to Lui.waitlistCheckinFrequency
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  
name Name String A display name for this entity.     One No  
descr Description RichText A description of the entity.     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  
typeKey Type Key String Unique identifier for the type of this object. Required Read only on updates One No  
stateKey State Key String Unique identifier for the state of this object. Required   One No