eedm.student-academic-programs.v11.0.student-academic-programs.json Maven / Gradle / Ivy
{
"title" : "Student Academic Programs",
"description" : "The academic programs in the home institution in which a student has beed enrolled.",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "ID",
"description" : "The global identifier of the student academic program.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"student" : {
"title" : "Student",
"description" : "The student who is enrolled in an academic program.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Student.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/persons/{id}",
"targetSchema" : {
"$ref" : "persons.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"program" : {
"title" : "Academic Program",
"description" : "The academic program in which a student is enrolled.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Academic Program.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/academic-programs/{id}",
"targetSchema" : {
"$ref" : "academic-programs.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"curriculumObjective" : {
"title" : "Curriculum Objective",
"description" : "The curriculum objective associated with the student's academic program.",
"enum" : [ "matriculated", "outcome" ],
"type" : "string"
},
"preference" : {
"title" : "Preference",
"description" : "Indicates the primary academic program of the student. Only one academic program should be set to preferred for a student.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "primary" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"programOwner" : {
"title" : "Program Owner",
"description" : "The owner of the academic program.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Program Owner.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/educational-institution-units/{id}",
"targetSchema" : {
"$ref" : "educational-institution-units.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"site" : {
"title" : "Site",
"description" : "The site (campus) at which the student is enrolled in the program.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Site.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/sites/{id}",
"targetSchema" : {
"$ref" : "sites.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"catalog" : {
"title" : "Academic Catalog",
"description" : "The academic catalog that defines the requirements for a student's enrollment in a program.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Academic Catalog.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/academic-catalogs/{id}",
"targetSchema" : {
"$ref" : "academic-catalogs.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"academicLevel" : {
"title" : "Academic Level",
"description" : "The academic level associated with the enrollment of the student in the academic program.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Academic Level.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/academic-levels/{id}",
"targetSchema" : {
"$ref" : "academic-levels.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"credentials" : {
"title" : "Credentials",
"description" : "The academic credentials that can be awarded for completing an academic program.",
"type" : "array",
"items" : {
"title" : "Credentials",
"description" : "The academic credentials that can be awarded for completing an academic program.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Credentials.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/academic-credentials/{id}",
"targetSchema" : {
"$ref" : "academic-credentials.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"disciplines" : {
"title" : "Disciplines",
"description" : "The academic disciplines offered as part of the academic program.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"discipline" : {
"title" : "Discipline",
"description" : "An academic discipline associated with an academic program.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Discipline.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/academic-disciplines/{id}",
"targetSchema" : {
"$ref" : "academic-disciplines.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"administeringInstitutionUnit" : {
"title" : "Administering Institution Unit",
"description" : "The institutional unit that administers the discipline (major, minor, concentration), typically a department within a school or college.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Administering Institution Unit.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/educational-institution-units/{id}",
"targetSchema" : {
"$ref" : "educational-institution-units.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"subdisciplines" : {
"title" : "Subdisciplines",
"description" : "A list of academic disciplines that are subordinate to the discipline.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"subdiscipline" : {
"title" : "Subdiscipline",
"description" : "An academic disciplines that is subordinate to the discipline.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Subdiscipline.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/academic-disciplines/{id}",
"targetSchema" : {
"$ref" : "academic-disciplines.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"administeringInstitutionUnit" : {
"title" : "Administering Institution Unit",
"description" : "The institutional unit that administers the sub-discipline (i.e concentration), typically a department within a school or college.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Administering Institution Unit.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/educational-institution-units/{id}",
"targetSchema" : {
"$ref" : "educational-institution-units.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "subdiscipline" ]
}
}
},
"additionalProperties" : false,
"required" : [ "discipline" ]
}
},
"startOn" : {
"title" : "Start Date",
"description" : "The date on which an academic program begins.",
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
},
"endOn" : {
"title" : "End Date",
"description" : "The date on which an academic program ends.",
"oneOf" : [ {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"academicPeriods" : {
"title" : "Academic Periods",
"description" : "Various academic periods related to a student's progression in a program.",
"type" : "object",
"properties" : {
"starting" : {
"title" : "Starting",
"description" : "The starting academic period of student's enrollment in the program",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Starting.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/academic-periods/{id}",
"targetSchema" : {
"$ref" : "academic-periods.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"expectedGraduation" : {
"title" : "Expected Graduation",
"description" : "The academic period in which the student is expected to graduate.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Expected Graduation.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/academic-periods/{id}",
"targetSchema" : {
"$ref" : "academic-periods.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"actualGraduation" : {
"title" : "Actual Graduation",
"description" : "The academic period in which the student actually graduated.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Actual Graduation.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/academic-periods/{id}",
"targetSchema" : {
"$ref" : "academic-periods.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false
},
"enrollmentStatus" : {
"title" : "Enrollment Status",
"description" : "The current state of a student's academic program enrollment.",
"type" : "object",
"properties" : {
"status" : {
"title" : "Enrollment Status",
"description" : "The status of the academic program enrollment.",
"enum" : [ "active", "inactive", "complete" ],
"type" : "string"
},
"detail" : {
"title" : "Detail",
"description" : "Details related to the academic enrollment.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Detail.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/enrollment-statuses/{id}",
"targetSchema" : {
"$ref" : "enrollment-statuses.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "status" ]
},
"performanceMeasure" : {
"title" : "Performance Measure",
"description" : "A measurement of the student's overall performance in the program (e.g. GPA).",
"type" : "string"
},
"recognitions" : {
"title" : "Recognitions",
"description" : "A list of academic recognitions the student has received.",
"type" : "array",
"items" : {
"title" : "Recognitions",
"description" : "A list of academic recognitions the student has received.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Recognitions.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/academic-honors/{id}",
"targetSchema" : {
"$ref" : "academic-honors.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"expectedGraduationDate" : {
"title" : "Expected Graduation Date",
"description" : "The date on which the student is expected to graduate from the academic program.",
"oneOf" : [ {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"graduatedOn" : {
"title" : "Graduated On",
"description" : "The date the student graduate from the program.",
"oneOf" : [ {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"credentialsDate" : {
"title" : "Credentials Date",
"description" : "The date when credentials were issued to the student for the program.",
"oneOf" : [ {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"thesisTitle" : {
"title" : "Thesis Title",
"description" : "The title of the thesis (dissertation).",
"type" : "string"
},
"creditsEarned" : {
"title" : "Credits Earned",
"description" : "The number of credits earned at the home institution during the course of study for the program.",
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
}
},
"required" : [ "id", "student", "program", "curriculumObjective", "startOn", "enrollmentStatus" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-programs?filter={\"student:\": {\"id\": $id}}",
"title" : "Student",
"description" : "The student who is enrolled in an academic program.",
"schema" : {
"type" : "object",
"properties" : {
"student" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "student-academic-programs.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-programs?filter={\"program:\": {\"id\": $id}}",
"title" : "Program",
"description" : "The academic program in which a student is enrolled.",
"schema" : {
"type" : "object",
"properties" : {
"program" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "student-academic-programs.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-programs?filter={\"site:\": {\"id\": $id}}",
"title" : "Site",
"description" : "The site (campus) at which the student is enrolled in the program.",
"schema" : {
"type" : "object",
"properties" : {
"site" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "student-academic-programs.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-programs?filter={\"academicLevel:\": {\"id\": $id}}",
"title" : "Academic Level",
"description" : "The academic level associated with the enrollment of the student in the academic program.",
"schema" : {
"type" : "object",
"properties" : {
"academicLevel" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "student-academic-programs.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-programs?filter={\"credentials:\": {\"id\": $id}}",
"title" : "Credentials",
"description" : "The academic credentials that can be awarded for completing an academic program.",
"schema" : {
"type" : "object",
"properties" : {
"credentials" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "student-academic-programs.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-programs?filter={\"startOn:\": {$startOn}}",
"title" : "Start On",
"description" : "The date on which an academic program begins.",
"schema" : {
"type" : "object",
"properties" : {
"startOn" : {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}
}
},
"targetSchema" : {
"$ref" : "student-academic-programs.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-programs?filter={\"endOn:\": {$endOn}}",
"title" : "End On",
"description" : "The date on which an academic program ends.",
"schema" : {
"type" : "object",
"properties" : {
"endOn" : {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}
}
},
"targetSchema" : {
"$ref" : "student-academic-programs.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-programs?filter={\"enrollmentStatus\":{\"status\":$status}}",
"schema" : {
"type" : "object",
"properties" : {
"enrollmentStatus" : {
"type" : "object",
"properties" : {
"status" : {
"enum" : [ "active", "inactive", "complete" ],
"type" : "string"
}
}
}
}
},
"targetSchema" : {
"$ref" : "student-academic-programs.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-programs?filter={\"graduatedOn:\": {$graduatedOn}}",
"title" : "Graduated On",
"description" : "The date the student graduate from the program.",
"schema" : {
"type" : "object",
"properties" : {
"graduatedOn" : {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}
}
},
"targetSchema" : {
"$ref" : "student-academic-programs.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-programs?filter={\"actualGraduation:\": {\"id\": $id}}",
"title" : "Actual Graduation",
"description" : "The academic period in which the student actually graduated.",
"schema" : {
"type" : "object",
"properties" : {
"actualGraduation" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "student-academic-programs.json#"
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy