All Downloads are FREE. Search and download functionalities are using the official Maven repository.

eedm.academic-programs.v15.2.0.academic-programs.json Maven / Gradle / Ivy

{
  "title" : "Academic Programs",
  "description" : "An offering by an institution that represents a combination of courses and requirements leading to a degree, diploma, or certificate for a defined set of majors, minors, or concentrations.",
  "version" : "15.2.0",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "The global identifier of an academic program.",
      "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 program.",
      "type" : "string",
      "minLength" : 1
    },
    "description" : {
      "title" : "Description",
      "description" : "The description of an academic program.",
      "type" : "string"
    },
    "code" : {
      "title" : "Code",
      "description" : "A code that identifies an academic program.",
      "type" : "string"
    },
    "authorizing" : {
      "title" : "Authorizing",
      "description" : "The institutional unit that authorizes the academic program.",
      "oneOf" : [ {
        "title" : "institution",
        "description" : "The institution that authorizes the academic program.",
        "type" : "object",
        "properties" : {
          "institution" : {
            "title" : "Institution",
            "description" : "The institution that authorizes the academic program.",
            "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" ]
          }
        },
        "additionalProperties" : false,
        "required" : [ "institution" ]
      }, {
        "title" : "institutionalUnit",
        "description" : "The institutional unit that authorizes the academic program.",
        "type" : "object",
        "properties" : {
          "institutionalUnit" : {
            "title" : "Institutional Unit",
            "description" : "The institutional unit that authorizes the academic program, typically a school or college within the institution.",
            "type" : "object",
            "properties" : {
              "id" : {
                "title" : "ID",
                "description" : "The global identifier for the Institutional Unit.",
                "type" : "string",
                "format" : "guid",
                "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
              }
            },
            "links" : [ {
              "rel" : "self",
              "href" : "/educational-institution-units/{id}",
              "targetSchema" : {
                "$ref" : "educational-institution-units.json#"
              }
            } ],
            "additionalProperties" : false,
            "required" : [ "id" ]
          }
        },
        "additionalProperties" : false,
        "required" : [ "institutionalUnit" ]
      }, {
        "title" : "organization",
        "description" : "The organization that authorizes the academic program.",
        "type" : "object",
        "properties" : {
          "organization" : {
            "title" : "Organization",
            "description" : "The organization that authorizes the academic program.",
            "type" : "object",
            "properties" : {
              "id" : {
                "title" : "ID",
                "description" : "The global identifier for the Organization.",
                "type" : "string",
                "format" : "guid",
                "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
              }
            },
            "links" : [ {
              "rel" : "self",
              "href" : "/organizations/{id}",
              "targetSchema" : {
                "$ref" : "organizations.json#"
              }
            } ],
            "additionalProperties" : false,
            "required" : [ "id" ]
          }
        },
        "additionalProperties" : false,
        "required" : [ "organization" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "programOwners" : {
      "title" : "Program Owners",
      "description" : "The owners of the academic program.",
      "type" : "array",
      "items" : {
        "title" : "Program Owners",
        "description" : "The owners of the academic program.",
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Program Owners.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/educational-institution-units/{id}",
          "targetSchema" : {
            "$ref" : "educational-institution-units.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }
    },
    "sites" : {
      "title" : "Sites",
      "description" : "The sites (campuses) the program is offered at",
      "type" : "array",
      "items" : {
        "title" : "Sites",
        "description" : "The sites (campuses) the program is offered at",
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Sites.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/sites/{id}",
          "targetSchema" : {
            "$ref" : "sites.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }
    },
    "academicLevel" : {
      "title" : "Academic Level",
      "description" : "The level of academic progress that is associated with an academic program.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Academic Level.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/academic-levels/{id}",
          "targetSchema" : {
            "$ref" : "academic-levels.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "credentials" : {
      "title" : "Credentials",
      "description" : "The academic credentials that can be awarded for completing an academic program.",
      "type" : "array",
      "items" : {
        "title" : "Credentials",
        "description" : "The academic credentials that can be awarded for completing an academic program.",
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Credentials.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/academic-credentials/{id}",
          "targetSchema" : {
            "$ref" : "academic-credentials.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }
    },
    "disciplines" : {
      "title" : "Discipline",
      "description" : "The academic disciplines offered as part of an academic program.",
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "discipline" : {
            "title" : "Discipline",
            "description" : "An academic discipline associated with the academic program.",
            "type" : "object",
            "properties" : {
              "id" : {
                "title" : "ID",
                "description" : "The global identifier for the Discipline.",
                "type" : "string",
                "format" : "guid",
                "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
              }
            },
            "links" : [ {
              "rel" : "self",
              "href" : "/academic-disciplines/{id}",
              "targetSchema" : {
                "$ref" : "academic-disciplines.json#"
              }
            } ],
            "additionalProperties" : false,
            "required" : [ "id" ]
          },
          "startOn" : {
            "title" : "Start On",
            "description" : "The start date of the discipline's relationship to the program.",
            "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])$"
          },
          "endOn" : {
            "title" : "End On",
            "description" : "The end date of the discipline's relationship to the program.",
            "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
            } ]
          },
          "administeringInstitutionUnit" : {
            "title" : "Administering Institution Unit",
            "description" : "The institution unit that administers the discipline (major, minor, concentration), typically a department within a school or college.",
            "oneOf" : [ {
              "type" : "object",
              "properties" : {
                "id" : {
                  "title" : "ID",
                  "description" : "The global identifier for the Administering Institution Unit.",
                  "type" : "string",
                  "format" : "guid",
                  "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
                }
              },
              "links" : [ {
                "rel" : "self",
                "href" : "/educational-institution-units/{id}",
                "targetSchema" : {
                  "$ref" : "educational-institution-units.json#"
                }
              } ],
              "additionalProperties" : false,
              "required" : [ "id" ]
            }, {
              "type" : "object",
              "maxProperties" : 0
            } ]
          },
          "programConstraint" : {
            "title" : "Program Constraint",
            "description" : "The state of the relationship of the discipline to the program within the given start and end dates. Required disciplines are part of the fundamental definition of the program and must be included for the program to be valid when the program is associated with a person.",
            "oneOf" : [ {
              "type" : "string",
              "enum" : [ "requiredDiscipline" ]
            }, {
              "type" : "string",
              "maxLength" : 0
            } ]
          },
          "administrativePeriodStart" : {
            "title" : "Administrative Period Start",
            "description" : "The earliest administrative period the discipline can be applied to the program when associated with a student.",
            "oneOf" : [ {
              "type" : "object",
              "properties" : {
                "id" : {
                  "title" : "ID",
                  "description" : "The global identifier for the Administrative Period Start.",
                  "type" : "string",
                  "format" : "guid",
                  "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
                }
              },
              "links" : [ {
                "rel" : "self",
                "href" : "/administrative-periods/{id}",
                "targetSchema" : {
                  "$ref" : "administrative-periods.json#"
                }
              } ],
              "additionalProperties" : false,
              "required" : [ "id" ]
            }, {
              "type" : "object",
              "maxProperties" : 0
            } ]
          },
          "administrativePeriodEnd" : {
            "title" : "Administrative Period End",
            "description" : "The latest administrative period the discipline can be applied to the program when associated with a student.",
            "oneOf" : [ {
              "type" : "object",
              "properties" : {
                "id" : {
                  "title" : "ID",
                  "description" : "The global identifier for the Administrative Period End.",
                  "type" : "string",
                  "format" : "guid",
                  "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
                }
              },
              "links" : [ {
                "rel" : "self",
                "href" : "/administrative-periods/{id}",
                "targetSchema" : {
                  "$ref" : "administrative-periods.json#"
                }
              } ],
              "additionalProperties" : false,
              "required" : [ "id" ]
            }, {
              "type" : "object",
              "maxProperties" : 0
            } ]
          },
          "parentDiscipline" : {
            "title" : "Parent Discipline",
            "description" : "The academic discipline that is one level higher in the discipline hierarchy.",
            "oneOf" : [ {
              "type" : "object",
              "properties" : {
                "id" : {
                  "title" : "ID",
                  "description" : "The global identifier for the Parent Discipline.",
                  "type" : "string",
                  "format" : "guid",
                  "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
                }
              },
              "links" : [ {
                "rel" : "self",
                "href" : "/academic-disciplines/{id}",
                "targetSchema" : {
                  "$ref" : "academic-disciplines.json#"
                }
              } ],
              "additionalProperties" : false,
              "required" : [ "id" ]
            }, {
              "type" : "object",
              "maxProperties" : 0
            } ]
          },
          "subdisciplines" : {
            "title" : "Subdisciplines",
            "description" : "A list of academic disciplines that are subordinate to the discipline.",
            "type" : "array",
            "items" : {
              "type" : "object",
              "properties" : {
                "subdiscipline" : {
                  "title" : "Subdiscipline",
                  "description" : "An academic discipline that is subordinate to the discipline.",
                  "type" : "object",
                  "properties" : {
                    "id" : {
                      "title" : "ID",
                      "description" : "The global identifier for the Subdiscipline.",
                      "type" : "string",
                      "format" : "guid",
                      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
                    }
                  },
                  "links" : [ {
                    "rel" : "self",
                    "href" : "/academic-disciplines/{id}",
                    "targetSchema" : {
                      "$ref" : "academic-disciplines.json#"
                    }
                  } ],
                  "additionalProperties" : false,
                  "required" : [ "id" ]
                }
              },
              "additionalProperties" : false,
              "required" : [ "subdiscipline" ]
            }
          }
        },
        "additionalProperties" : false,
        "required" : [ "discipline", "startOn" ]
      }
    },
    "status" : {
      "title" : "Status",
      "description" : "The status of an academic program.",
      "enum" : [ "active", "inactive" ],
      "type" : "string"
    },
    "startOn" : {
      "title" : "Start Date",
      "description" : "The date that an academic program starts.",
      "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])$"
    },
    "endOn" : {
      "title" : "End Date",
      "description" : "The date that an academic program ends.",
      "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
      } ]
    },
    "administrativePeriodStart" : {
      "title" : "Administrative Period Start",
      "description" : "The earliest administrative period the program can be assigned to a student.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Administrative Period Start.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/administrative-periods/{id}",
          "targetSchema" : {
            "$ref" : "administrative-periods.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "administrativePeriodEnd" : {
      "title" : "Administrative Period End",
      "description" : "The latest administrative period the program can be assigned to a student.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Administrative Period End.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/administrative-periods/{id}",
          "targetSchema" : {
            "$ref" : "administrative-periods.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    }
  },
  "required" : [ "id", "title", "status", "startOn" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "namedQuery",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/academic-programs?academicCatalog={\"academicCatalog\": {\"id\": $id}}",
    "name" : "academicCatalog",
    "title" : "Academic Catalog",
    "description" : "Filter to return academic programs by academic catalog.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "academicCatalog" : {
          "type" : "string",
          "format" : "guid",
          "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
        }
      }
    },
    "targetSchema" : {
      "$ref" : "academic-programs.json#"
    }
  }, {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/academic-programs?criteria={\"academicLevel\": {\"id\": $id}}",
    "title" : "Academic Level",
    "description" : "The level of academic progress that is associated with an academic program.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "academicLevel" : {
          "type" : "object",
          "properties" : {
            "id" : {
              "type" : "string",
              "format" : "guid",
              "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
            }
          }
        }
      }
    },
    "targetSchema" : {
      "$ref" : "academic-programs.json#"
    }
  }, {
    "rel" : "namedQuery",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/academic-programs?recruitmentProgram={\"recruitmentProgram\": {$recruitmentProgram}}",
    "name" : "recruitmentProgram",
    "title" : "Recruitment Program",
    "description" : "Filter to return academic programs identified for use with recruitment.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "recruitmentProgram" : {
          "enum" : [ "active" ],
          "type" : "string"
        }
      }
    },
    "targetSchema" : {
      "$ref" : "academic-programs.json#"
    }
  } ]
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy