eedm.student-transcript-grades-options.v1.0.0.student-transcript-grades-options.json Maven / Gradle / Ivy

Go to download
{
  "title" : "Student Transcript Grades Options",
  "description" : "The options associated with the student transcript grade.",
  "version" : "1.0.0",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "The global identifier of the student transcript grade.",
      "type" : "string",
      "format" : "guid",
      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
    },
    "gradeScheme" : {
      "title" : "Grade Scheme",
      "description" : "The grading scheme used to award the student their grade.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "detail" : {
            "title" : "Detail",
            "description" : "The grading scheme used to award the student their grade.",
            "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" : "/grade-schemes/{id}",
              "targetSchema" : {
                "$ref" : "grade-schemes.json#"
              }
            } ],
            "additionalProperties" : false,
            "required" : [ "id" ]
          },
          "title" : {
            "title" : "Title",
            "description" : "The full name of the grading scheme.",
            "type" : "string"
          }
        },
        "additionalProperties" : false,
        "required" : [ "detail" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "grades" : {
      "title" : "Grades",
      "description" : "The grading options associated with the student transcript grade.",
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "grade" : {
            "title" : "Grade",
            "description" : "The grade that may be awarded to the student by the instructor.",
            "type" : "object",
            "properties" : {
              "id" : {
                "title" : "ID",
                "description" : "The global identifier for the Grade.",
                "type" : "string",
                "format" : "guid",
                "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
              }
            },
            "links" : [ {
              "rel" : "self",
              "href" : "/grade-definitions/{id}",
              "targetSchema" : {
                "$ref" : "grade-definitions.json#"
              }
            } ],
            "additionalProperties" : false,
            "required" : [ "id" ]
          },
          "value" : {
            "title" : "Value",
            "description" : "The grade value.",
            "type" : "string"
          },
          "incompleteGrade" : {
            "title" : "Incomplete Grade",
            "description" : "The default incomplete final grade and the extension date associated with the student's grade.",
            "type" : "object",
            "properties" : {
              "finalGrade" : {
                "title" : "Final Grade",
                "description" : "The default final grade.",
                "oneOf" : [ {
                  "type" : "object",
                  "properties" : {
                    "id" : {
                      "title" : "ID",
                      "description" : "The global identifier for the Final Grade.",
                      "type" : "string",
                      "format" : "guid",
                      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
                    }
                  },
                  "links" : [ {
                    "rel" : "self",
                    "href" : "/grade-definitions/{id}",
                    "targetSchema" : {
                      "$ref" : "grade-definitions.json#"
                    }
                  } ],
                  "additionalProperties" : false,
                  "required" : [ "id" ]
                }, {
                  "type" : "object",
                  "maxProperties" : 0
                } ]
              },
              "extensionDate" : {
                "title" : "Extension Date",
                "description" : "The date after which the default final grade may be applied.",
                "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
          }
        },
        "additionalProperties" : false,
        "required" : [ "grade" ]
      }
    }
  },
  "required" : [ "id" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "namedQuery",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/student-transcript-grades?student={\"student\": {\"id\": $id}}",
    "name" : "student",
    "title" : "Student",
    "description" : "Filter to return student associated with a transcript grade.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "student" : {
          "type" : "string",
          "format" : "guid",
          "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
        }
      }
    },
    "targetSchema" : {
      "$ref" : "student-transcript-grades.json#"
    }
  } ]
}