ActivityOfferingInfo

Name ActivityOfferingInfo
Usage CourseOfferingService
getActivityOffering getActivityOfferingsByIds getActivityOfferingsByCourseOffering getActivityOfferingsByFormatOffering getActivityOfferingsWithoutClusterByFormatOffering getActivityOfferingsByFormatOfferingWithoutRegGroup createActivityOffering copyActivityOffering generateActivityOfferings updateActivityOffering validateActivityOffering validateActivityOfferingCluster searchForActivityOfferings
Type Complex

Description

Individual activity offerings correspond to events in a scheduling
system, each with a meeting pattern.

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  
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  
name Name String A display name for this entity.     One No  
descr Description RichTextInfo A description of the entity.     One No  
formatOfferingId Format Offering Id String Format offering Id used to create this activity Required   One No  
formatOfferingName Format Offering Name String Format offering Name used to create this activity Required   One No  
activityId Activity Id String Canonical activity whose instance is this activity offering. Required   One No  
termId Term Id String Academic term the activity is being offered in.

Same as course offering term or a nested term of course
offering.		 Required   One No map to Lui.getAtpId
termCode Term Code String Academic term code the activity is being offered in.

Same as course offering term or a nested term of course
offering.		 Required   One No map to Lui.getAtpCode
activityCode Activity Code String Alphanumeric character that identifies the section of the
course offering.		     One No  
scheduleId Schedule Id String Gets the schedule Id for this offering.     One No maps to Scheduling service not implemented
isHonorsOffering Is Honors Offering Boolean Indicates that the course is an Honors Course. Required   One No  
gradingOptionKeys Grading Option Keys StringList The options/scales that indicate the allowable grades that can
be awarded. If the value is set here then the canonical course
must have a grading option set on the canonical activity.		     Many No maps to Lui.gradingOptions
instructors Instructors OfferingInstructorInfoList Instructors for the activity. This list should be constrained
by the instructors listed on the course offering.		     Many No maps to Lui.instructors
weeklyInclassContactHours Weekly Inclass Contact Hours String When/for how long does the offering meet in class. Calculated
by system based on meeting times; may be validated against
canonical. The unit is hours.		     One No  
weeklyOutofclassContactHours Weekly Outofclass Contact Hours String When/for how long does the offering meet out of class. Entered
by Scheduler. The unit is hours.		     One No  
weeklyTotalContactHours Weekly Total Contac Hours String When/for how long does the offering meet in total. Calculated
by system based as sum of In Class and Out of Class hours. The
unit is hours.		     One No  
isEvaluated Instructor Evaluation Flag Boolean Is there an instructor evaluation for this activity offering.     One No  
maximumEnrollment Maximum Enrollment Integer Total maximum number of "seats" or enrollment slots that can be
filled for the offering.		     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.		     One No maps to Lui.minimumEnrollment
isMaxEnrollmentEstimate Is Maximum Enrollment Estimate Flag Boolean Is maximum enrollment estimate flag     One No  
finalExamStartTime Final Exam StartTime Date Start time of final exam     One No  
finalExamEndTime Final Exam EndTime Date End time of final exam.     One No  
finalExamSpaceCode Final Exam Space Code String Space code where final exam will be conducted     One No  
activityOfferingURL Activity Offering URL String Gets the URL for this offering.     One No  
courseOfferingId Course Offering Id String Course Offering id the activity is being offered in. Required   One No maps to the containing formatOffering's courseOfferingId
courseOfferingTitle Course Offering Title String Course Offering title the activity is being offered in. Required   One No maps to the containing formatOffering's courseOffering's title
courseOfferingCode Course Offering Code String Course Offering code the activity is being offered in. Required   One No maps to the containing formatOffering's courseOffering's code
hasWaitlist Has Waitlist Boolean Indicates whether a RegistrationGroup has a waitlist. Required   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. Required   One No maps to Lui.isWaitlistCheckinRequired
waitlistCheckinFrequency Waitlist Checkin Frequency TimeAmountInfo Frequency for the waitlist checkin.     One No maps to Lui.waitlistCheckinFrequency
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