Versions Compared

Key

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

...

ResourcePropertyNameIsCollectionDATA_TYPE

REQUIRED/

OPTIONAL

Scenario 1

POST

Scenario 2

POST

Scenario 3

PUT

StudentAcademicRecords

educationOrganizationReference

FALSE

educationOrganizationReference

REQUIRED

 

educationOrganizationReference

educationOrganizationId

FALSE

integer

REQUIRED

255901107

255901001

255901001

StudentAcademicRecords

schoolYearTypeReference

FALSE

schoolYearTypeReference

REQUIRED

 

schoolYearTypeReference

schoolYear

FALSE

integer

REQUIRED

[Current

School

Year]

[Current

School

Year]

[Current

School

Year]

StudentAcademicRecords

studentReference

FALSE

studentReference

REQUIRED

 

studentReference

studentUniqueId

FALSE

string

REQUIRED

111111

222222

222222

StudentAcademicRecords

termDescriptor

FALSE

string

REQUIRED

Fall Semester

Fall Semester

Fall Semester

StudentAcademicRecords

cumulativeAttemptedCreditConversion

FALSE

decimal

OPTIONAL

 

 

 

StudentAcademicRecords

cumulativeAttemptedCredits

FALSE

decimal

REQUIRED

[System calculated value

| 0]

[System calculated value

| 40]

[Previous system

calculated value + 3

| 43]

StudentAcademicRecords

cumulativeAttemptedCreditTypeDescriptor

cumulativeAttemptedCreditTypeDescriptor

FALSE

string

OPTIONAL

 

 

 

StudentAcademicRecords

cumulativeEarnedCreditConversion

FALSE

decimal

OPTIONAL

 

 

 

StudentAcademicRecords

cumulativeEarnedCredits

FALSE

decimal

REQUIRED

[System calculated value

| 0]

[System calculated value

| 38]

[Previous system

calculated value + 3

| 41]

StudentAcademicRecords

cumulativeEarnedCreditTypeDescriptor

cumulativeEarnedCreditTypeDescriptor

FALSE

string

OPTIONAL

 

 

 

StudentAcademicRecords

cumulativeGradePointAverage

FALSE

decimal

OPTIONAL

 

 

 

StudentAcademicRecords

cumulativeGradePointsEarned

FALSE

decimal

OPTIONAL

 

 

 

StudentAcademicRecords

gradeValueQualifier

FALSE

string

OPTIONAL

 

 

 

StudentAcademicRecords

projectedGraduationDate

FALSE

datetime

OPTIONAL

 

 

 

StudentAcademicRecords

sessionAttemptedCreditConversion

FALSE

decimal

OPTIONAL

 

 

 

StudentAcademicRecords

sessionAttemptedCredits

FALSE

decimal

REQUIRED

 

[System calculated value

| 3]

[Previous system

calculated value + 3

| 6]

StudentAcademicRecords

sessionAttemptedCreditTypeDescriptor

sessionAttemptedCreditTypeDescriptor

FALSE

string

OPTIONAL

 

 

 

StudentAcademicRecords

sessionEarnedCreditConversion

FALSE

decimal

OPTIONAL

 

 

 

StudentAcademicRecords

sessionEarnedCredits

FALSE

decimal

REQUIRED

 

[System calculated value

| 3]

[Previous system

calculated value + 3

| 6]

StudentAcademicRecords

sessionEarnedCreditTypeDescriptor

sessionEarnedCreditTypeDescriptor

FALSE

string

OPTIONAL

 

 

 

StudentAcademicRecords

sessionGradePointAverage

FALSE

decimal

OPTIONAL

 

 

 

StudentAcademicRecords

sessionGradePointsEarned

FALSE

decimal

OPTIONAL

 

 

 

StudentAcademicRecords

reportCards

TRUE

studentAcademicRecordReportCard[]

OPTIONAL

 

studentAcademicRecordReportCards

reportCardReference

FALSE

Reference

OPTIONAL

 

reportCardReference

gradingPeriodSchoolId

FALSE

integer

OPTIONAL

 

 

 

reportCardReference

gradingPeriodSchoolYear

FALSE

integer

OPTIONAL




reportCardReference

gradingPeriodSequence

FALSE

integer

OPTIONAL




reportCardReference

studentUniqueId

FALSE

string

OPTIONAL

 

 

 

reportCardReference

gradingPeriodDescriptor

FALSE

string

OPTIONAL

 

 

 

reportCardReference

educationOrganizationId

FALSE

integer

OPTIONAL

 

 

 

StudentAcademicRecords

academicHonors

TRUE

studentAcademicRecordAcademicHonor[]

OPTIONAL

 

studentAcademicRecordAcademicHonors

academicHonorCategoryDescriptor

academicHonorCategoryDescriptor

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordAcademicHonors

achievementCategoryDescriptor

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordAcademicHonors

achievementCategorySystem

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordAcademicHonors

achievementTitle

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordAcademicHonors

criteria

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordAcademicHonors

criteriaURL

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordAcademicHonors

evidenceStatement

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordAcademicHonors

honorAwardDate

FALSE

datetime

OPTIONAL

 

 

 

studentAcademicRecordAcademicHonors

honorAwardExpiresDate

FALSE

datetime

OPTIONAL

 

 

 

studentAcademicRecordAcademicHonors

honorDescription

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordAcademicHonors

imageURL

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordAcademicHonors

issuerName

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordAcademicHonors

issuerOriginURL

FALSE

string

OPTIONAL

 

 

 

StudentAcademicRecords

classRanking

FALSE

studentAcademicRecordClassRanking

OPTIONAL

 

studentAcademicRecordClassRankings

classRank

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordClassRankings

totalNumberInClass

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordClassRankings

classRankingDate

FALSE

datetime

OPTIONAL

 

 

 

studentAcademicRecordClassRankings

percentageRanking

FALSE

string

OPTIONAL

 

 

 

StudentAcademicRecords

diplomas

TRUE

studentAcademicRecordDiploma[]

OPTIONAL

 

studentAcademicRecordDiplomas

achievementCategoryDescriptor

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordDiplomas

diplomaAwardDate

FALSE

datetime

OPTIONAL

 

 

 

studentAcademicRecordDiplomas

diplomaTypeDescriptor

diplomaTypeDescriptor

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordDiplomas

achievementCategorySystem

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordDiplomas

achievementTitle

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordDiplomas

criteria

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordDiplomas

criteriaURL

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordDiplomas

cteCompleter

FALSE

boolean

OPTIONAL

 

 

 

studentAcademicRecordDiplomas

diplomaAwardExpiresDate

FALSE

datetime

OPTIONAL

 

 

 

studentAcademicRecordDiplomas

diplomaDescription

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordDiplomas

diplomaLevelDescriptor

diplomaLevelDescriptor

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordDiplomas

evidenceStatement

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordDiplomas

imageURL

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordDiplomas

issuerName

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordDiplomas

issuerOriginURL

FALSE

string

OPTIONAL

 

 

 

StudentAcademicRecords

recognitions

TRUE

studentAcademicRecordRecognition[]

OPTIONAL

 

studentAcademicRecordRecognitions

achievementCategoryDescriptor

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordRecognitions

recognitionTypeDescriptor

recognitionTypeDescriptor

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordRecognitions

achievementCategorySystem

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordRecognitions

achievementTitle

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordRecognitions

criteria

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordRecognitions

criteriaURL

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordRecognitions

evidenceStatement

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordRecognitions

imageURL

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordRecognitions

issuerName

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordRecognitions

issuerOriginURL

FALSE

string

OPTIONAL

 

 

 

studentAcademicRecordRecognitions

recognitionAwardDate

FALSE

datetime

OPTIONAL

 

 

 

studentAcademicRecordRecognitions

recognitionAwardExpiresDate

FALSE

datetime

OPTIONAL

 

 

 

studentAcademicRecordRecognitions

recognitionDescription

FALSE

string

OPTIONAL