eedm.student-cohorts.v7.2.0.student-cohorts.json Maven / Gradle / Ivy

Go to download
{
  "title" : "Student Cohorts",
  "description" : "The list of valid student cohorts.",
  "version" : "7.2.0",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "The global identifier of the student cohort.",
      "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 the student cohort.",
      "type" : "string",
      "minLength" : 1
    },
    "description" : {
      "title" : "Description",
      "description" : "The description of the student cohort.",
      "type" : "string"
    },
    "code" : {
      "title" : "Code",
      "description" : "The code that identifies the student cohort.",
      "type" : "string"
    },
    "startOn" : {
      "title" : "Start On",
      "description" : "The first date when when students may be assigned to the cohort.",
      "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 when students may be assigned to the cohort.",
      "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
      } ]
    },
    "initialAcademicPeriod" : {
      "title" : "Initial Academic Period",
      "description" : "The first academic period when students may be assigned to the cohort.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Initial 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
      } ]
    },
    "finalAcademicPeriod" : {
      "title" : "Final Academic Period",
      "description" : "The last academic period when students may be assigned to the cohort.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Final 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
      } ]
    },
    "type" : {
      "title" : "Type",
      "description" : "The type of cohort (e.g. federal).",
      "oneOf" : [ {
        "type" : "string",
        "enum" : [ "federal" ]
      }, {
        "type" : "string",
        "maxLength" : 0
      } ]
    }
  },
  "required" : [ "id", "title" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/student-cohorts?criteria={\"code\": {$code}}",
    "title" : "Code",
    "description" : "The code that identifies the student cohort.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "code" : {
          "type" : "string"
        }
      }
    },
    "targetSchema" : {
      "$ref" : "student-cohorts.json#"
    }
  } ]
}