StudentCourseRecordInfo

Name StudentCourseRecordInfo
Usage AcademicRecordService
getAttemptedCourseRecordsForTerm getCompletedCourseRecords getCompletedCourseRecordsForCourse getCompletedCourseRecordsForTerm
Type Complex

Description

Information about a Student Course Record. A Student Course Record
contains information on the courses a student has taken.

include notes on Id

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  
courseOfferingId Course Offering Id String Id of the course that was taken by the student   Read only One No  
sourceTypeKey Source Type Key String The Source is represented by a Type to indicate what crated
this record. Examples are "native" that implies the exietence
of a Course Registration or a "transfer articulation" that may
imply the existence of other data.		   Read only One No  
courseRegistrationId Course Registration Id String The Id of the Course Registration. A Course Registration Id is
available for native source types.		 Required Read only One No  
personId Person Id String The Id of the Student. Required Read only One No retrieved from the Course Registration
courseTitle Course Title String The title of the course that was in effect at the time
the student took the course.		 Required Read only One No retrieved from the CourseOffering related to the Course
Registration
courseCode Course Code String The code or number of the course that was in effect at the time
the student took the course.		 Required Read only One No retrieved from the Registration Group related to the Course
Registration
activityCode Activity Code String The code or number of the primary activity or section that was
in effect at the time the student took the course.		 Required Read only One No retrieved from the Course Offering related to the Course
Registration
termName Term Name String The name of the term in which the student took the offering.     One No retrieved from the Term related to the Course Offering
in the Course Registration
courseBeginDate Course Begin Date Date The start date of the course.     One No retrieved from the Term related to the Course Offering
in the Course Registration
courseEndDate Course End Date Date The end date of the course.     One No retrieved from the Term related to the Course Offering
in the Course Registration
assignedGradeValue Assigned Grade Value String The grade the student was assigned for the course.     One No  
assignedGradeScaleKey Assigned Grade Scale Key String The Id for the grading scale for the assigned grade.     One No the Id of the Result Scale
administrativeGradeValue Administrative Grade Value Key String The grade the student was assigned for the course.     One No  
administrativeGradeScaleKey Administrative Grade Scale Key String The Id for the grading scale for the administrative grade.     One No the Id of the Result Scale
calculatedGradeValue Calculated Grade Value String The calculated grade the student earned for the course.     One No  
calculatedGradeScaleKey Calculated Grade Scale Key String The Id for the grading scale for the calculated grade.     One No the Key of the Result Scale
creditsAttempted Credits Attempted String The number of credits the student attempted for this course. Required   One No  
creditsEarned Credits Earned String The number of credits the student earned for this course.     One No  
creditsForGPA Credits For GPA String The number of credits to be applied for the GPA calculation.
This is provides a weighting to this course for the GPA.		     One No  
countsTowardCredits Counts Toward Credits Boolean If this student record counts toward the cumultive credits.     One No  
isRepeated Is Repeated Boolean If this course is a repeat of a previous offering. the student
took.		     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