eedm.financial-aid-years.v7.1.0.financial-aid-years.json Maven / Gradle / Ivy

Go to download
{
  "title" : "Financial Aid Years",
  "description" : "The designated years associated with Financial Aid Awards.",
  "version" : "7.1.0",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "The global identifier of the financial aid year.",
      "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 financial aid year.",
      "type" : "string",
      "minLength" : 1
    },
    "description" : {
      "title" : "Description",
      "description" : "The description of the financial aid year.",
      "type" : "string"
    },
    "code" : {
      "title" : "Code",
      "description" : "The code that identifies the financial aid year.",
      "type" : "string"
    },
    "startOn" : {
      "title" : "Start On",
      "description" : "The start date of the financial aid year.",
      "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 end date of the financial aid year.",
      "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
      } ]
    },
    "status" : {
      "title" : "Status",
      "description" : "The status of the financial aid year.",
      "enum" : [ "active", "inactive" ],
      "type" : "string"
    }
  },
  "required" : [ "id", "title", "status" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "namedQuery",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/financial-aid-years?academicPeriod={\"academicPeriod\": {\"id\": $id}}",
    "name" : "academicPeriod",
    "title" : "Academic Period",
    "description" : "Filter by academic period.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "academicPeriod" : {
          "type" : "string",
          "format" : "guid",
          "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
        }
      }
    },
    "targetSchema" : {
      "$ref" : "financial-aid-years.json#"
    }
  } ]
}