eedm.student-academic-periods.v1.0.0.student-academic-periods.json Maven / Gradle / Ivy
{
"title" : "Student Academic Periods",
"description" : "Information about a student for a specified academic period.",
"version" : "1.0.0",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "ID",
"description" : "The global identifier of the student academic period.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"person" : {
"title" : "Person",
"description" : "The person who is associated with the academic period.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Person.",
"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" ]
},
"academicPeriod" : {
"title" : "Academic Period",
"description" : "The academic period to which the student has been associated.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Academic Period.",
"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" ]
},
"academicLevels" : {
"title" : "Academic Levels",
"description" : "The distinct academic levels associated with the student for this period.",
"type" : "array",
"minItems" : 1,
"items" : {
"type" : "object",
"properties" : {
"academicLevel" : {
"title" : "Academic Level",
"description" : "The distinct academic level associated with the student for this period.",
"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" ]
},
"priority" : {
"title" : "Priority",
"description" : "An indicator as to whether the academic level is the primary for the student.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "primary" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "academicLevel" ]
}
},
"academicStatuses" : {
"title" : "Academic Statuses",
"description" : "The student academic statuses for the period.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"basis" : {
"title" : "Basis",
"description" : "An indicator as to whether the academic status is established for the student overall or specific to a student's academic level.",
"javaType" : "com.ellucian.generated.eedm.student_academic_periods.v1_0_0.BasisEnum",
"enum" : [ "byLevel", "overall" ],
"type" : "string"
},
"academicLevel" : {
"title" : "Academic Level",
"description" : "The academic level associated with the academic period status.",
"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
} ]
},
"academicPeriodStatus" : {
"title" : "Academic Period Status",
"description" : "The student academic status for the period as established by the institution.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Academic Period Status.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/student-academic-period-statuses/{id}",
"targetSchema" : {
"$ref" : "student-academic-period-statuses.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "basis", "academicPeriodStatus" ]
}
},
"academicLoads" : {
"title" : "Academic Loads",
"description" : "The student calculated academic loads for the period.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"basis" : {
"title" : "Basis",
"description" : "An indicator as to whether the academic load is established for the student overall or specific to a student's academic level.",
"javaType" : "com.ellucian.generated.eedm.student_academic_periods.v1_0_0.BasisEnum",
"enum" : [ "byLevel", "overall" ],
"type" : "string"
},
"academicLevel" : {
"title" : "Academic Level",
"description" : "The academic level associated with the academic load.",
"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
} ]
},
"academicLoad" : {
"title" : "Academic Load",
"description" : "The student calculated academic load for the period.",
"javaType" : "com.ellucian.generated.eedm.student_academic_periods.v1_0_0.AcademicLoadEnum",
"enum" : [ "partTime", "overload", "fullTime" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "basis", "academicLoad" ]
}
}
},
"required" : [ "id", "person", "academicPeriod", "academicLevels" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-periods?criteria={\"person\": {\"id\": $id}}",
"title" : "Person",
"description" : "The person who is associated with the academic period.",
"schema" : {
"type" : "object",
"properties" : {
"person" : {
"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-periods.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-periods?criteria={\"academicPeriod\": {\"id\": $id}}",
"title" : "Academic Period",
"description" : "The academic period to which the student has been associated.",
"schema" : {
"type" : "object",
"properties" : {
"academicPeriod" : {
"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-periods.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-periods?criteria={\"academicStatuses\": [{\"academicPeriodStatus\": {\"id\": $id}}]}",
"title" : "Academic Period Status",
"description" : "The student academic status for the period as established by the institution.",
"schema" : {
"type" : "object",
"properties" : {
"academicStatuses" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"academicPeriodStatus" : {
"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-periods.json#"
}
}, {
"rel" : "namedQuery",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-periods?personFilter={\"personFilter\": {\"id\": $id}}",
"name" : "personFilter",
"title" : "Person Filter",
"description" : "Retrieve information for a specified population.",
"schema" : {
"type" : "object",
"properties" : {
"personFilter" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
},
"targetSchema" : {
"$ref" : "student-academic-periods.json#"
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy