SeatPoolDefinitionInfo

Name SeatPoolDefinitionInfo
Usage CourseOfferingService
getSeatPoolDefinition getSeatPoolDefinitionsForActivityOffering createSeatPoolDefinition updateSeatPoolDefinition validateSeatPoolDefinition searchForSeatpoolDefinitions
Type Complex

Description

Information about a single seat pool that can be associated with
either a course offering or registration group. Seat pools provides
a handle for statements that will be used to created enrollment
restrictions based on capacity. Seat pools are ordered using rank
to enable the most restrictive pools to be filled first.

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  
expirationMilestoneTypeKey Expiration Milestone Type Key String When this seat pool definition expires. A seat pool whose state
is active is active once the registration period for the
related ActivityOffering begins. The restriction may expire
before the end of the registration period on a Milestone. The
Milestone is determined by the Expiration Milestone Type Key on
the ATP for the registration period.		     One No  
isPercentage Is Percentage Boolean Tests if the seat limit is an absolute number or a percentage
of MaximumEnrollment in the ActivityOffering.		 Required   One No  
seatLimit Seat Limit Integer The limit on the number of seats in this pool. The number may
be expressed as an absolute number or as an integer
representing a percentage (0-100) based on the IsPercentage
flag.		     One No  
processingPriority Processing Priority Integer Indicates the order in which this seat pool will be processed
during registration. During registration students should be
assigned to a seat pool with the lowest possible rank to which
he or she meets the restriction requirements.		     One No  
populationId Population Id String The Population to which this seat pool applies.     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