CluIdentifierInfo

Name CluIdentifierInfo
Usage CluService
CluInfo
Type Complex

Description

Detailed information about the human readable form of a CLU Identifier

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  
code Code String The composite string that is used to officially reference or publish the
CLU. Note it may have an internal structure that each Institution may
want to enforce. This structure may be composed from the other parts of
the structure such as Level amp; Division, but may include items such as
cluType.		     One No  
shortName Short Name String Abbreviated name of the CLU, commonly used on transcripts     One No  
longName Long Name String Descriptive name of the CLU     One No  
level Level String A code that indicates whether this is introductory, advanced, etc.     One No  
division Division String A code that indicates what school, program, major, subject area, etc.
Examples: "Chem", "18"		     One No  
variation Variation String A number that indicates the sequence or order of versions in cases where
several different Clus have the same offical Identifier		     One No  
suffixCode Suffix Code String ???     One No  
orgId Org Id String ???     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