eedm.student-attendances.v10.0.student-attendances.json Maven / Gradle / Ivy

Go to download
{
  "title" : "Student Attendances",
  "description" : "The detailed information of students' attendances at instructional events.",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "The global identifier of the student attendance.",
      "type" : "string",
      "format" : "guid",
      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
    },
    "student" : {
      "title" : "Student",
      "description" : "The student for whom attendance was taken.",
      "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" ]
    },
    "instructionalEvent" : {
      "title" : "Instructional Event",
      "description" : "The instructional event for which the student’s attendance applies.",
      "type" : "object",
      "properties" : {
        "id" : {
          "title" : "ID",
          "description" : "The global identifier for the Instructional Event.",
          "type" : "string",
          "format" : "guid",
          "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
        }
      },
      "links" : [ {
        "rel" : "self",
        "href" : "/instructional-events/{id}",
        "targetSchema" : {
          "$ref" : "instructional-events.json#"
        }
      } ],
      "additionalProperties" : false,
      "required" : [ "id" ]
    },
    "instructionalEventInstance" : {
      "title" : "Instructional Event Instance",
      "description" : "The instance of the instructional event for which attendance was taken.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Instructional Event Instance.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/instructional-event-instances/{id}",
          "targetSchema" : {
            "$ref" : "instructional-event-instances.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "attendanceTaken" : {
      "title" : "Attendance Taken",
      "description" : "The date and time for which the attendance applies.",
      "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])?$"
    },
    "attendance" : {
      "title" : "Attendance",
      "description" : "The categorization of the student's attendance.",
      "type" : "object",
      "properties" : {
        "category" : {
          "title" : "Category",
          "description" : "The student’s attendance category.",
          "enum" : [ "presentFull", "presentPartial", "absentExcused", "absentNotExcused" ],
          "type" : "string"
        },
        "detail" : {
          "title" : "Detail",
          "description" : "A user defined category applied to the student's attendance.",
          "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" : "/attendance-categories/{id}",
              "targetSchema" : {
                "$ref" : "attendance-categories.json#"
              }
            } ],
            "additionalProperties" : false,
            "required" : [ "id" ]
          }, {
            "type" : "object",
            "maxProperties" : 0
          } ]
        }
      },
      "additionalProperties" : false,
      "required" : [ "category" ]
    },
    "percentAttended" : {
      "title" : "Percent Attended",
      "description" : "The percentage of the total session time the student was in attendance.",
      "oneOf" : [ {
        "type" : "number"
      }, {
        "type" : "null"
      } ]
    },
    "comment" : {
      "title" : "Comment",
      "description" : "Comments regarding the student’s attendance.",
      "type" : "string"
    }
  },
  "required" : [ "id", "student", "instructionalEvent", "attendanceTaken", "attendance" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "sectionAttendance",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/student-attendances?sectionAttendance={\"sectionId\": $sectionId}",
    "title" : "Section Attendance",
    "description" : "Retrive student attendance information for a specific section",
    "schema" : {
      "type" : "object",
      "properties" : {
        "sectionId" : {
          "type" : "string",
          "format" : "guid",
          "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
        }
      }
    },
    "targetSchema" : {
      "$ref" : "student-attendances.json#"
    }
  } ]
}