eedm.academic-catalogs.v6.1.0.academic-catalogs.json Maven / Gradle / Ivy

Go to download
{
  "title" : "Academic Catalogs",
  "description" : "A catalog listing of the courses offered by an organization.",
  "version" : "6.1.0",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "A global identifier of an academic catalog for use in all external references.",
      "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 an academic catalog.",
      "type" : "string",
      "minLength" : 1
    },
    "description" : {
      "title" : "Description",
      "description" : "A full description of an academic catalog.",
      "type" : "string"
    },
    "code" : {
      "title" : "Code",
      "description" : "The code that identifies an academic catalog.",
      "type" : "string"
    },
    "startOn" : {
      "title" : "Start Date",
      "description" : "The beginning date for when an academic catalog takes effect.",
      "oneOf" : [ {
        "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])?$"
      }, {
        "type" : "string",
        "maxLength" : 0
      } ]
    },
    "endOn" : {
      "title" : "End Date",
      "description" : "The ending date for when an academic catalog is no longer in effect.",
      "oneOf" : [ {
        "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])?$"
      }, {
        "type" : "string",
        "maxLength" : 0
      } ]
    },
    "status" : {
      "title" : "Status",
      "description" : "A status of an academic catalog. Not currently in use.",
      "oneOf" : [ {
        "type" : "string",
        "enum" : [ "active", "inactive" ]
      }, {
        "type" : "string",
        "maxLength" : 0
      } ]
    },
    "institution" : {
      "title" : "Institution",
      "description" : "The educational institution that owns the academic catalog",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Institution.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/educational-institutions/{id}",
          "targetSchema" : {
            "$ref" : "educational-institutions.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "academicPrograms" : {
      "title" : "Academic Programs",
      "description" : "Academic programs that make up the catalog.",
      "type" : "array",
      "items" : {
        "title" : "Academic Programs",
        "description" : "Academic programs that make up the catalog.",
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Academic Programs.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/academic-programs/{id}",
          "targetSchema" : {
            "$ref" : "academic-programs.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }
    }
  },
  "required" : [ "id", "title" ],
  "additionalProperties" : false
}