RegistrationRequestItemInfo

Name RegistrationRequestItemInfo
Usage CourseRegistrationService
getRegistrationRequestItemsForCourseRegistration getRegistrationRequestItemsByCourseOfferingAndStudent
RegistrationRequestInfo
Type Complex

Description

Represents a single transaction item for a Student and Registration
Group.

The possible types of RegistrationRequestItem are ADD, DROP, SWAP
or UPDATE. These types represent adding (waitlisting, holdlisting),
dropping courses, swapping sections, or changing the registration
options.

The Transaction Item Type indicates if this is for an ADD, DROP,
SWAP or UPDATE.

1. Register for course - RegistrationRequestItem Type is ADD,
newRegistrationGroupId is the RegistrationGroup.

2. Register for course but waitlist if seat not available OR
waitlist for course - same as above and okToWaitlist is true.

3. Swap between RegistrationGroup within same CourseOffering - Type
is SWAP, both new and existing RegistrationGroup Ids populated. New
RegistrationGroup is to be the one replaced with the old
one. RegistrationGroups are in the same CourseOffering.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
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 Yes  
name Name String A display name for this entity.     One No  
descr Description RichTextInfo A description of the entity.     One No  
typeKey Type Key String A unique identifier for the type of this object. Required Read only One Yes  
stateKey State Key String A unique identifier for the state of this object. Required   One Yes  
registrationRequestId Registration Request Id String The RegistrationRequest to which this item belongs.   Read only One No  
studentId Student Id String The Student to which this request item applies. Required Read only on update One No  
newRegistrationGroupId Registration Group Id String The RegistrationGroup to which the student will be registered
upon a successful submission of this item. This is populated
for ADD, DROP, UPDATE and SWAP types of
RegistrationRequestItems.		     One No LprTransactionItem.newLuiId
existingRegistrationGroupId Existing Registration Group Id String In the case of a DROP or SWAP, the "existing" registration
group Id indicates the current RegistrationGroup to which the
student is currently registered. For an ADD, this field should
be null.		     One No LprTransactionItem.existingLuiId
credits Credits String The desired number of credits. This value is a number
represented as a string.		     One No LprTransactionItem.ResultValuesGroups filtering on the
ResultValuesGroup Type for a credit option.
gradingOptionId Grading Option Id String The requested grading scheme option (e.g. A-F or Pass/Fail).     One No LprTransactionItem.ResultValuesGroups filtering on the
ResultValuesGroup Type for a grade system
okToWaitlist Ok To Waitlist Boolean If the course is full and there is a waitlist, is it okay to be
placed in the waitlist for the course.		     One No  
okToHoldUntilList Ok To HoldUntillist Boolean If the student does not meet one of the requirements for the
course but there is a list for such students because the
requirement ends at a future date, is it okay to be placed in
such a list.		     One No  
meta Meta MetaInfo 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  
attributes Dynamic Attributes AttributeInfoList 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