Program Entry
A ProgramEntry represents an academic
record entry for a Program. The fields in
the ProgramEntry may be for the entire
enrollment through the academic career or specific to
an academic Term.
A ProgramEntry is also an
OsidRelationship between the student and
Program. The effectiveness of the
OsidRelationship describes the
effectiveness of the academic record entry itself, not
the student's enrollment in the Program.
A ProgramEntry may be superseded with a
manual update or forced entry and the temporal nature
of the relationship provides a history of changes to
the academic record.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
studentId |
id | the student Id |
|
student |
Resource | the student | |
programId |
id | the program Id |
|
program |
Program | the program | |
isPartOf |
boolean | true if this program entry has a parent, false
otherwise |
|
parentProgramEntryId |
id | the parent program entry Id |
|
parentProgramEntry |
ProgramEntry | the parent program entry | |
isMatriculationKnown |
boolean | true if the matriculation status is known, false
otherwise |
|
entranceDate |
datetime | the entrance date | |
entranceTermId |
id | the entrance term Id |
|
entranceTerm |
Term | the entrance term | |
isExpectedToComplete |
boolean | true if an expected completion is known, false
otherwise |
|
expectedCompletionDate |
datetime | the expected completion date | |
expectedCompletionTermId |
id | the expected completion term Id |
|
expectedCompletionTerm |
Term | the expected completion term | |
isEnrolled |
boolean | true if the student is enrolled, false otherwise |
|
isActivelyEnrolled |
boolean | true if the student is actively enrolled, false
otherwise |
|
isOnLeave |
boolean | true if the student is on leave, false otherwise |
|
hasWithdrawn |
boolean | true if the student withdrew, false otherwise |
|
withdrawDate |
datetime | the withdraw date | |
withdrawTermId |
id | the withdraw term Id |
|
withdrawTerm |
Term | the withdraw term | |
isComplete |
boolean | true if the program has been completed, false
otherwise |
|
completionDate |
datetime | the completion date | |
completionTermId |
id | the completion term Id |
|
completionTerm |
Term | the completion term | |
levelId |
id | the level Id |
|
level |
Grade | the level | |
standingId |
id | the standing Id |
|
standing |
Grade | the standing | |
admissionDate |
datetime | the admission date | |
isForTerm |
boolean | true if the program has a term, false otherwise |
|
termId |
id | the term Id |
|
term |
Term | the term | |
creditScaleId |
id | the grade system Id |
|
creditScale |
GradeSystem | the grade system | |
creditsEarned |
decimal | the credits earned | |
hasGPA |
boolean | true if a GPA is available, false otherwise |
|
gPAScaleId |
id | the grade system Id |
|
gPAScale |
GradeSystem | the grade system | |
gPA |
decimal | the GPA | |
hasEnrollments |
boolean | true if enrollments are available, false
otherwise |
|
enrollmentIds |
id | ⋆ | the enrollment Ids |
enrollments |
Enrollment | ⋆ | the enrollments |
Course Entry
A CourseEntry represents an academic
record entry for a course. The fields in the
CourseEntry are specific to a
Term.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
studentId |
id | the student Id |
|
student |
Resource | the student | |
courseId |
id | the course Id |
|
course |
Course | the course | |
termId |
id | the term Id |
|
term |
Term | the term | |
isRegistrationKnown |
boolean | true if the course begin and end dates are known,
false otherwise |
|
courseBeginDate |
datetime | the course begin date | |
courseEndDate |
datetime | the course end date | |
isComplete |
boolean | true if the course has been completed, false
otherwise |
|
creditScaleId |
id | the grade system Id |
|
creditScale |
GradeSystem | the grade system | |
creditsEarned |
decimal | the credits earned | |
hasGrade |
boolean | true if a grade is available, false otherwise |
|
gradeId |
id | the grade Id |
|
grade |
Grade | the grade | |
hasScore |
boolean | true if a score is available, false otherwise |
|
scoreScaleId |
id | the grade system Id |
|
scoreScale |
GradeSystem | the grade system | |
score |
decimal | the score | |
hasRegistrations |
boolean | true if registrations are available, false
otherwise |
|
registrationIds |
id | ⋆ | the registrations Ids |
registrations |
Registration | ⋆ | the registrations |
Credential Entry
A CredentialEntry represents an
academic record entry for a credential.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
studentId |
id | the student Id |
|
student |
Resource | the student | |
credentialId |
id | the credential Id |
|
credential |
Credential | the credential | |
isMatriculationKnown |
boolean | true if the matriculation status is known, false
otherwise |
|
startDate |
datetime | the start date | |
startTermId |
id | the start term Id |
|
startTerm |
Term | the start term | |
isExpectedToComplete |
boolean | true if an expected completion is known, false
otherwise |
|
expectedCompletionDate |
datetime | the expected completion date | |
expectedCompletionTermId |
id | the expected completion term Id |
|
expectedCompletionTerm |
Term | the expected completion term | |
isActivelyPursuing |
boolean | true if the credential is being actively pursued,
false otherwise |
|
isPaused |
boolean | true if the pursuit of the credential is paused,
false otherwise |
|
isAbandoned |
boolean | true if the pursuit of the credential has been abandoned,
false otherwise |
|
abandonDate |
datetime | the abandon date | |
abandonTermId |
id | the abandon term Id |
|
abandonTerm |
Term | the abandon term | |
isAwarded |
boolean | true if the credential has been awarded, false
otherwise |
|
awardDate |
datetime | the award date | |
awardTermId |
id | the award term Id |
|
awardTerm |
Term | the award term | |
dateAwarded |
datetime | the date awarded | |
hasProgram |
boolean | true if a program is available, false otherwise |
|
programId |
id | the program Id |
|
program |
Program | the program |
Assessment Entry
An AssessmentEntry represents an
academic record entry for an assessment. It is
intended to record standardized tests and other major
assessments associated with an academic record.
Quizzes within a course are tracked in the Grading
OSID.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
studentId |
id | the student Id |
|
student |
Resource | the student | |
assessmentId |
id | the assessment Id |
|
assessment |
Assessment | the assessment | |
dateCompleted |
datetime | the date completion | |
hasProgram |
boolean | true if a program is available, false otherwise |
|
programId |
id | the program Id |
|
program |
Program | the program | |
hasCourse |
boolean | true if a course is available, false otherwise |
|
courseId |
id | the course Id |
|
course |
Course | the course | |
hasGrade |
boolean | true if a grade is available, false otherwise |
|
gradeId |
id | the grade Id |
|
grade |
Grade | the grade | |
hasScore |
boolean | true if a score is available, false otherwise |
|
scoreScaleId |
id | the grade system Id |
|
scoreScale |
GradeSystem | the grade system | |
score |
decimal | the score |
Award Entry
An AwardEntry represents an academic
record entry for a recognition.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
studentId |
id | the student Id |
|
student |
Resource | the student | |
awardId |
id | the award Id |
|
award |
Award | the award | |
dateAwarded |
datetime | the date awarded | |
hasProgram |
boolean | true if a program is available, false otherwise |
|
programId |
id | the program Id |
|
program |
Program | the program | |
hasCourse |
boolean | true if a course is available, false otherwise |
|
courseId |
id | the course Id |
|
course |
Course | the course | |
hasAssessment |
boolean | true if an assessment is available, false
otherwise |
|
assessmentId |
id | the assessment Id |
|
assessment |
Assessment | the assessment |