eedm.sections.v8.0.sections.json Maven / Gradle / Ivy
{
"title" : "Sections",
"description" : "An instance of a course.",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "ID",
"description" : "A globally unique identifier of a section to be used in all external references.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"title" : {
"title" : "Title",
"description" : "The full name of a section.",
"type" : "string",
"minLength" : 1
},
"description" : {
"title" : "Description",
"description" : "A description of a section.",
"type" : "string"
},
"startOn" : {
"title" : "Offering Start Date",
"description" : "The starting date at which a section may be scheduled to be taken.",
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
},
"endOn" : {
"title" : "Offering End Date",
"description" : "The ending date at which a section may no longer be scheduled to be taken.",
"oneOf" : [ {
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"code" : {
"title" : "Section Code",
"description" : "The human-readable identifier of a section. It is generally unique within an academic period.",
"type" : "string"
},
"number" : {
"title" : "Section Number",
"description" : "A numbering scheme or other mark that distinguishes between multiple sections. It is generally unique within an academic period and course.",
"type" : "string"
},
"instructionalPlatform" : {
"title" : "Instructional Platform",
"description" : "A technology platform used to manage the administration of a section.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Instructional Platform.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/instructional-platforms/{id}",
"targetSchema" : {
"$ref" : "instructional-platforms.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"academicPeriod" : {
"title" : "Academic Period",
"description" : "The academic time period associated with a section.",
"oneOf" : [ {
"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" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"administrativePeriod" : {
"title" : "Administrative Time Period",
"description" : "The administrative time period associated with a section.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Administrative Time Period.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/administrative-periods/{id}",
"targetSchema" : {
"$ref" : "administrative-periods.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"censusDates" : {
"title" : "Census Dates",
"description" : "The dates at which the section's enrollment/headcount is determined. These dates override the census dates for the academic period, if they are different.",
"type" : "array",
"items" : {
"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",
"format" : "date"
}
},
"course" : {
"title" : "Course",
"description" : "The smallest unit of instruction for which an Oganization grants credits.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Course.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/courses/{id}",
"targetSchema" : {
"$ref" : "courses.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"credits" : {
"title" : "Credit",
"description" : "Unit specification that can be awarded for completing a section.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"creditCategory" : {
"title" : "Credit Category",
"description" : "",
"type" : "object",
"properties" : {
"creditType" : {
"title" : "Credit Type",
"description" : "The higher-level category of academic credits.",
"enum" : [ "ce", "institution", "transfer", "exchange", "exam", "workLifeExperience", "other", "noCredit" ],
"type" : "string"
},
"detail" : {
"title" : "Detail",
"description" : "",
"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" : "/credit-categories/{id}",
"targetSchema" : {
"$ref" : "credit-categories.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "creditType" ]
},
"measure" : {
"title" : "Unit of Measure",
"description" : "A unit or standard of measurement.",
"enum" : [ "credit", "ceu", "hours" ],
"type" : "string"
},
"minimum" : {
"title" : "Minimum number",
"description" : "The lower, inclusive bound of a numeric range of values.",
"type" : "number"
},
"maximum" : {
"title" : "Maximum number",
"description" : "The upper, inclusive bound of a numeric range of values.",
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"increment" : {
"title" : "Increment number",
"description" : "The multiple by which a numeric range of values can be stepped from the minimum to the maximum. For example, a range of 1 to 3 with an increment of 1 would evaluate to 1, 2, or 3. Specifying an increment of 0.5 would evaluate to 1, 1.5, 2, 2.5, or 3",
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false,
"required" : [ "creditCategory", "measure", "minimum" ]
}
},
"site" : {
"title" : "Site",
"description" : "The primary location within the organization where a section's meetings will be held",
"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
} ]
},
"academicLevels" : {
"title" : "Academic Level",
"description" : "The levels of academic progress that can be associated with a section",
"type" : "array",
"items" : {
"title" : "Academic Level",
"description" : "The levels of academic progress that can be associated with a section",
"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" ]
}
},
"gradeSchemes" : {
"title" : "Grade Schemes",
"description" : "The grading schemes that may be used to award a grade to a student in this section of the course. Must be a subset of the grade schemes of the course.",
"type" : "array",
"items" : {
"title" : "Grade Schemes",
"description" : "The grading schemes that may be used to award a grade to a student in this section of the course. Must be a subset of the grade schemes of the course.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Grade Schemes.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/grade-schemes/{id}",
"targetSchema" : {
"$ref" : "grade-schemes.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"courseLevels" : {
"title" : "Course Levels",
"description" : "The levels of a course",
"type" : "array",
"items" : {
"title" : "Course Levels",
"description" : "The levels of a course",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Course Levels.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/course-levels/{id}",
"targetSchema" : {
"$ref" : "course-levels.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"status" : {
"title" : "Status",
"description" : "The status of a section, for example, \"Open\" or \"Closed\".",
"oneOf" : [ {
"type" : "string",
"enum" : [ "closed", "open", "pending", "cancelled" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"duration" : {
"title" : "Duration",
"description" : "The scheme for calculating the duration of a section",
"oneOf" : [ {
"type" : "object",
"properties" : {
"length" : {
"title" : "Length",
"description" : "The duration length, expressed in duration units.",
"type" : "number"
},
"unit" : {
"title" : "Unit",
"description" : "The calendar period of time equivalent to 1 unit of duration.",
"enum" : [ "days", "weeks", "months", "years" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "length", "unit" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"maxEnrollment" : {
"title" : "Maximum Enrollment",
"description" : "The maximum number of persons who are allowed to enroll for a section.",
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"owningInstitutionUnits" : {
"title" : "Owning Institution Units",
"description" : "The units (departments) of the educational institution which own, or are responsible for, a course",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"institutionUnit" : {
"title" : "Institution Unit",
"description" : "A unit (department) of the educational institution",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the 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" ]
},
"ownershipPercentage" : {
"title" : "Percent Ownership",
"description" : "The rate or proportion per hundred of ownership that is attributable to the organization.",
"type" : "number"
}
},
"additionalProperties" : false,
"required" : [ "institutionUnit", "ownershipPercentage" ]
}
},
"billing" : {
"title" : "Billing",
"description" : "The number of units that may be used to calculate the charge for the section as part of registration processing.",
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"reportingDetail" : {
"title" : "Reporting Detail",
"description" : "Additional properties required for localized reporting.",
"oneOf" : [ {
"title" : "Nebraska Reporting",
"description" : "Additional reporting detail for Nebraska.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"type" : {
"title" : "Type",
"description" : "The locality requiring additional reporting properties.",
"enum" : [ "Nebraska" ],
"type" : "string"
},
"lab" : {
"title" : "Lab",
"description" : "The number of lab hours that may be assigned to the section.",
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"lecture" : {
"title" : "Lecture",
"description" : "The number of lecture hours that may be assigned to the section.",
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"contact" : {
"title" : "Contact",
"description" : "The number of contact hours that may be assigned to the section.",
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
}
},
"additionalProperties" : false,
"required" : [ "type" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
} ]
}
},
"required" : [ "id", "title", "startOn", "course" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "instructionalEvents",
"title" : "Instructional Events",
"description" : "The instructional events associated with a section",
"href" : "/instructional-events?section.id={id}",
"targetSchema" : {
"$ref" : "instructional-events.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/sections/",
"schema" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string"
},
"startOn" : {
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
},
"endOn" : {
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
},
"code" : {
"type" : "string"
},
"number" : {
"type" : "string"
},
"instructionalPlatform" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"academicPeriod" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"course" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"academicLevels" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"site" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"status" : {
"type" : "string",
"enum" : [ "closed", "open", "pending", "cancelled" ]
},
"owningInstitutionUnits" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}, {
"rel" : "searchable",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/sections?searchable={searchable}",
"title" : "searchable section",
"description" : "Check if a section is searchable or hidden",
"schema" : {
"type" : "object",
"properties" : {
"searchable" : {
"type" : "string",
"enum" : [ "yes", "no", "hidden" ]
}
}
},
"targetSchema" : {
"$ref" : "sections.json#"
}
}, {
"rel" : "keywordSearch",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/sections?keywordSearch={keywordSearch}",
"title" : "Keyword Search",
"description" : "perform a keyword search",
"schema" : {
"type" : "object",
"properties" : {
"keywordSearch" : {
"type" : "string"
}
}
},
"targetSchema" : {
"$ref" : "sections.json#"
}
}, {
"rel" : "subject",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/sections?courses?subject={\"subject.id\": {id}}",
"title" : "Subject",
"description" : "Filter on subjects",
"schema" : {
"type" : "object",
"properties" : {
"subject" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
},
"targetSchema" : {
"$ref" : "sections.json#"
}
}, {
"rel" : "instructor",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/sections?instructional-events?instructor={\"instructor.id\": {id}}",
"title" : "Instructor",
"description" : "Filter on instructor",
"schema" : {
"type" : "object",
"properties" : {
"instructor" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
},
"targetSchema" : {
"$ref" : "sections.json#"
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy