LuiInfo

Name LuiInfo
Usage LuiService
getLui getLuisByIds getLuisByAtpAndClu searchForLuis validateLui createLui updateLui getLuisByRelatedLuiAndRelationType getRelatedLuisByLuiAndRelationType getLuiLuiRelationsByLuiAndRelatedLuiType
Type Complex

Description

Detailed information about a single LUI.

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  
effectiveDate Effective Date Date Date/time this object became effective. Must be less than or
equal to the expirationDate specified.		     One No  
expirationDate Expiration Date Date Date/time this relationship is no longer effective. Must be
greater than or equal to the effectiveDate specified.		     One No  
officialIdentifier Official Identifier LuiIdentifierInfo The LUI identifier.     One No  
alternateIdentifiers Alternate Identifiers LuiIdentifierInfoList The alternate LUI identifiers.     Many No  
cluId Clu Id String The unique identifier for the Canonical Learning Unit
(CLU) of which this is an instance.		 Required   One No  
cluCluRelationIds Clu Clu Relation Ids StringList Any Clu Clu Relation identifiers on which this instance is
based. While the LUI is in instance of a CLU, the LUI may be an
instance of a set of CLUs related to the principal CLU, such as
a Course Format.		     Many No  
atpId Atp Id String The unique identifier for the Academic Time Period (ATP)
for which this instance is offered.		 Required   One No  
campusLocations Campus Location Keys StringList Places where this LUI is offered. This is a temporary field
that parallels the campus enumeration in CLU. It may evolve
into a list of Campus Ids when we work that out.		     Many No  
scheduleId Schedule Id String The Schedule Id.     One No  
luiCodes codes LuCodeInfoList List of LU code info structures. These are structures so that
many different types of codes can be associated with the
clu. This allows them to be put into categories.		     Many No  
maximumEnrollment Maximum Enrollment Integer The total maximum number of "seats" or enrollment slots that
can be filled for the lui.		     One No  
minimumEnrollment Minimum Enrollment Integer Total minimum number of seats that must be filled for the lui.     One No  
referenceURL referenceURL String The reference URL for this LUI.     One No  
unitsContentOwner Units Content Owner Org Id StringList Identifiers for Organization(s) that is responsible for the academic content of
the Lui as approved in its canonical form.		     Many No  
unitsDeployment Units Deployment Org Id StringList Identifiers for Organization(s) that is responsible for the delivery - and all
associated logistics - of the Lui.		     Many No  
resultValuesGroupKeys Result Values Group Keys StringList The options/scales that indicate the allowable grades that can
be awarded or credits applied.

If the value is set here then the Clu must have a
grading option or credit options set on the canonical activity.

ResultValuesGroup will contain grade values valid for this
course offering.		     Many No  
relatedLuiTypes Related Lui Types StringList These are the related lui types which may be related to this lui, e.g., activty
offering types to format offering		     Many 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