eedm.student-academic-credentials.v1.0.0.student-academic-credentials.json Maven / Gradle / Ivy
{
"title" : "Student Academic Credentials",
"description" : "The academic credentials the student has been awarded.",
"version" : "1.0.0",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "ID",
"description" : "The global identifier of the student academic credential.",
"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 has been awarded an academic credential.",
"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" ]
},
"studentProgram" : {
"title" : "Student Program",
"description" : "The student academic program associated with the academic credential.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Student Program.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/student-academic-programs/{id}",
"targetSchema" : {
"$ref" : "student-academic-programs.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"academicLevel" : {
"title" : "Academic Level",
"description" : "The academic level associated with the academic credential.",
"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 awarded to the student.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"credential" : {
"title" : "Credential",
"description" : "The academic credential that has been awarded.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Credential.",
"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" ]
},
"earnedOn" : {
"title" : "Earned On",
"description" : "The date when the person earned the credential.",
"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
} ]
}
},
"additionalProperties" : false,
"required" : [ "credential" ]
}
},
"disciplines" : {
"title" : "Disciplines",
"description" : "The disciplines associated with the awarded credentials.",
"type" : "array",
"items" : {
"title" : "Disciplines",
"description" : "The disciplines associated with the awarded credentials.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Disciplines.",
"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" ]
}
},
"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" ]
}
},
"graduatedOn" : {
"title" : "Graduated On",
"description" : "The date the student graduated 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
} ]
},
"thesisTitle" : {
"title" : "Thesis Title",
"description" : "The title of the thesis (dissertation).",
"type" : "string"
},
"graduationAcademicPeriod" : {
"title" : "Graduation Academic Period",
"description" : "The academic period in which the student graduated.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Graduation 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
} ]
},
"graduationYear" : {
"title" : "Graduation Year",
"description" : "The year in which the student graduated.",
"type" : "string"
}
},
"required" : [ "id", "student", "credentials" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-credentials?criteria={\"student\": {\"id\": $id}}",
"title" : "Student",
"description" : "The student who has been awarded an academic credential.",
"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-credentials.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-credentials?criteria={\"studentProgram\": {\"id\": $id}}",
"title" : "Student Program",
"description" : "The academic program associated with the academic credential.",
"schema" : {
"type" : "object",
"properties" : {
"studentProgram" : {
"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-credentials.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-credentials?criteria={\"academicLevel\": {\"id\": $id}}",
"title" : "Academic Level",
"description" : "The academic level associated with the academic credential.",
"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-credentials.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-credentials?criteria={\"credentials\":[{\"credential\":{\"id\":$id}}]}",
"title" : "Credential",
"description" : "The academic credential that has been awarded.",
"schema" : {
"type" : "object",
"properties" : {
"credentials" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"credential" : {
"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-credentials.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-credentials?criteria={\"graduatedOn\": {$graduatedOn}}",
"title" : "Graduated On",
"description" : "The date the student graduated 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-credentials.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-credentials?criteria={\"graduationAcademicPeriod\": {\"id\": $id}}",
"title" : "Graduation Academic Period",
"description" : "The academic period in which the student graduated.",
"schema" : {
"type" : "object",
"properties" : {
"graduationAcademicPeriod" : {
"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-credentials.json#"
}
}, {
"rel" : "namedQuery",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-credentials?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-credentials.json#"
}
}, {
"rel" : "namedQuery",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-academic-credentials?academicPrograms={\"academicPrograms\": {\"id\": $id}}",
"name" : "academicPrograms",
"title" : "Academic Programs",
"description" : "Filter to return student academic credentials by academic program.",
"schema" : {
"type" : "object",
"properties" : {
"academicPrograms" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
},
"targetSchema" : {
"$ref" : "student-academic-credentials.json#"
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy