home

RegResponseItem

Name RegResponseItem
Usage CourseRegistrationService
RegResponseInfo
Type Complex

Description

A more granular status object than the Registration response which gives the
response status of the individual registration item, i.e., a course reg
group. It has a reference to the Course Registration in case of a successful
registration. The response contains status such as SUCCESS or FAILURE and
then necessary messages, warning or errors. The state of the response in case
of a success can be registered, waitlisted, or holdlisted.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
operationStatusInfo Operation Status Info OperationStatusInfo Get the operation status info for the registration item.     One No  
courseRegistrationId Course Registration Id String Gets the course registration (if any) that resulted from this registration transaction     One No  
courseWaitlistEntryId Course Waitlist Entry Id String Gets the waitlist entry (if any) that resulted from this registration transaction     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.
Required on updates Read only One No