home

RegResponse

Name RegResponse
Usage CourseRegistrationService
RegRequestInfo
Type Complex

Description

 

Structure Definition

ShortName Name Type Description Cardinality XML Attribute? Implementation Notes
regMessages Reg Messages StringList This method gets the item reg message displaying it to the user Many No  
overallRegStatus Overall Reg Status String The status of registration for the overall registration. One No  
regWarnings Reg Warnings StringList Any warnings that need to be shown for the registration
attempt.		 Many No  
regErrors Reg Errors StringList Returns any errors for the overall registration process. Many No  
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
 One No  
name Name String A display name for this entity. One No  
descr Description RichText A description of the entity. One No  
attributes Dynamic Attributes AttributeList 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  
meta Create/Update meta info Meta 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.		 One No  
typeKey Type Key String Unique identifier for the type of this object. One No  
stateKey State Key String Unique identifier for the state of this object. One No