eedm.student-registration-eligibilities.v9.0.student-registration-eligibilities.json Maven / Gradle / Ivy

Go to download
{
  "title" : "Student Registration Eligibilities",
  "description" : "It provides information on the registration eligibility of the student.",
  "type" : "object",
  "properties" : {
    "student" : {
      "title" : "Student",
      "description" : "The student for which registration eligibility is provided.",
      "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" ]
    },
    "academicPeriod" : {
      "title" : "Academic Period",
      "description" : "The academic period for which registration eligibility is provided.",
      "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" ]
    },
    "startOn" : {
      "title" : "Start On",
      "description" : "The date when a student may first register for the academic period.",
      "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
      } ]
    },
    "endOn" : {
      "title" : "End On",
      "description" : "The last date when a student may register for the academic period.",
      "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
      } ]
    },
    "alternatePin" : {
      "title" : "Alternate Pin",
      "description" : "An indication if an alternate pin is required for the student to register.",
      "oneOf" : [ {
        "type" : "string",
        "enum" : [ "required", "notRequired" ]
      }, {
        "type" : "string",
        "maxLength" : 0
      } ]
    },
    "eligibilityStatus" : {
      "title" : "Eligibility Status",
      "description" : "The indication if the student is eligible to register for the academic period.",
      "enum" : [ "eligible", "ineligible" ],
      "type" : "string"
    },
    "ineligibilityReasons" : {
      "title" : "Ineligibility Reasons",
      "description" : "The reasons the student is not eligibile to register.",
      "type" : "array",
      "items" : {
        "type" : "string"
      }
    },
    "priorityRegistrationTimeSlots" : {
      "title" : "Priority Registration Time Slots",
      "description" : "Time periods when the student is assigned priority registration.",
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "startOn" : {
            "title" : "Start On",
            "description" : "The date and time when the student's priority registration starts.",
            "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" : "End On",
            "description" : "The date and time when the student's priority registration ends.",
            "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])?$"
          }
        },
        "additionalProperties" : false,
        "required" : [ "startOn", "endOn" ]
      }
    },
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    }
  },
  "required" : [ "student", "academicPeriod", "eligibilityStatus" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/student-registration-eligibilities/",
    "schema" : {
      "type" : "object",
      "properties" : {
        "student" : {
          "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}$"
        }
      }
    }
  } ]
}