Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This interchange defines transcript information for a course and student academic records for a given session. Course transcripts link to the student academic record for the session in which the course was taken.

...

ResourcePropertyNameIsCollectionDATA_TYPE

REQUIRED/

OPTIONAL

Scenario 1

POST

Scenario 2

POST

Scenario 3

PUT

Scenario 4

PUT

CourseTranscripts

courseReference

FALSE

courseReference

REQUIRED

 

 

 

 

courseReference

educationOrganizationId

FALSE

integer

REQUIRED

255901107

255901001

255901107

255901001

courseReference

courseCode

FALSE

string

REQUIRED

ELA-01

03100500

ELA-01

03100500

CourseTranscripts

externalEducationOrganizationReference

FALSE

externalEducationOrganizationReference

OPTIONAL

 

 

 

 

externalEducationOrganizationReference

educationOrganizationId

FALSE

integer

OPTIONAL





CourseTranscripts

studentAcademicRecordReference

FALSE

studentAcademicRecordReference

REQUIRED

 

 

 

 

studentAcademicRecordReference

educationOrganizationId

FALSE

integer

REQUIRED

255901107

255901001

255901107

255901001

studentAcademicRecordReference

schoolYear

FALSE

integer

REQUIRED

[Current

School

Year]

[Current

School

Year]

[Current

School

Year]

[Current

School

Year]

studentAcademicRecordReference

studentUniqueId

FALSE

string

REQUIRED

111111

222222

111111

222222

studentAcademicRecordReference

termDescriptor

FALSE

string

REQUIRED

Fall Semester

Fall Semester

Fall Semester

Fall Semester

CourseTranscripts

courseAttemptResultDescriptor

courseAttemptResultDescriptor

FALSE

string

REQUIRED

Pass

Pass

Pass

Pass

CourseTranscripts

alternativeCourseCode

FALSE

string

OPTIONAL

 

 

 

 

CourseTranscripts

alternativeCourseTitle

FALSE

string

OPTIONAL

 

 

 

 

CourseTranscripts

attemptedCreditConversion

FALSE

number

OPTIONAL

 

 

 

 

CourseTranscripts

attemptedCredits

FALSE

number

REQUIRED

 

3

 

3

CourseTranscripts

attemptedCreditTypeDescriptor

attemptedCreditTypeDescriptor

FALSE

string

OPTIONAL

 

 

 

 

CourseTranscripts

courseRepeatCodeDescriptor

courseRepeatCodeDescriptor

FALSE

string

OPTIONAL

 

 

 

 

CourseTranscripts

courseTitle

FALSE

string

OPTIONAL

 

 

 

 

CourseTranscripts

earnedCreditConversion

FALSE

number

OPTIONAL

 

 

 

 

CourseTranscripts

earnedCredits

FALSE

number

REQUIRED

 

3

 

3

CourseTranscripts

earnedCreditTypeDescriptor

earnedCreditTypeDescriptor

FALSE

string

OPTIONAL

 

 

 

 

CourseTranscripts

finalLetterGradeEarned

FALSE

string

REQUIRED

B

B

A

CourseTranscripts

finalNumericGradeEarned

FALSE

string

REQUIRED

83

98

87

100

CourseTranscripts

methodCreditEarnedDescriptor

methodCreditEarnedDescriptor

FALSE

string

OPTIONAL

 

 

 

 

CourseTranscripts

whenTakenGradeLevelDescriptor

FALSE

string

OPTIONAL

 

 

 

 

CourseTranscripts

earnedAdditionalCredits

TRUE

courseTranscriptEarnedAdditionalCredits[]

OPTIONAL

 

 

 

 

courseTranscriptEarnedAdditionalCredits

additionalCreditTypeDescriptor

additionalCreditTypeDescriptor

FALSE

string

OPTIONAL

 

 

 

 

courseTranscriptEarnedAdditionalCredits

credits

FALSE

number

OPTIONAL