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

eedm.admission-applications.v16.0.0.admission-applications.json Maven / Gradle / Ivy

{
  "title" : "Admission Applications",
  "description" : "Higher education institution admission applications.",
  "version" : "16.0.0",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "The global identifier of the admission application.",
      "type" : "string",
      "format" : "guid",
      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
    },
    "referenceId" : {
      "title" : "Reference ID",
      "description" : "The identifier of the application at its origin",
      "type" : "string"
    },
    "applicant" : {
      "title" : "Applicant",
      "description" : "The person applying for the admission.",
      "type" : "object",
      "properties" : {
        "id" : {
          "title" : "ID",
          "description" : "The global identifier for the Applicant.",
          "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" ]
    },
    "applicationAcademicPrograms" : {
      "title" : "Application Academic Programs",
      "description" : "The identifier of the applicant and the academic programs for which they have applied.",
      "type" : "array",
      "items" : {
        "title" : "Application Academic Programs",
        "description" : "The identifier of the applicant and the academic programs for which they have applied.",
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Application Academic Programs.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/student-academic-programs/{id}",
          "targetSchema" : {
            "$ref" : "student-academic-programs.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }
    },
    "type" : {
      "title" : "Type",
      "description" : "The type of the application",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Type.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/admission-application-types/{id}",
          "targetSchema" : {
            "$ref" : "admission-application-types.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "academicPeriod" : {
      "title" : "Academic Period",
      "description" : "The starting academic period for the admission",
      "oneOf" : [ {
        "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" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "applicationSource" : {
      "title" : "Application Source",
      "description" : "The source of information associated with the application.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Application Source.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/admission-application-sources/{id}",
          "targetSchema" : {
            "$ref" : "admission-application-sources.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "owner" : {
      "title" : "Owner",
      "description" : "The institution representative assigned to manage the application",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Owner.",
            "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" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "admissionPopulation" : {
      "title" : "Admission Population",
      "description" : "The type of admission populations the applicant belongs to",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Admission Population.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/admission-populations/{id}",
          "targetSchema" : {
            "$ref" : "admission-populations.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "site" : {
      "title" : "Site",
      "description" : "The institution site (campus) selected by the applicant",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Site.",
            "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" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "residencyType" : {
      "title" : "Residency Type",
      "description" : "The residency type of the applicant (e.g. international).",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Residency Type.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/residency-types/{id}",
          "targetSchema" : {
            "$ref" : "residency-types.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "academicLoad" : {
      "title" : "Academic Load",
      "description" : "The academic load selection, e.g., full- or part-time",
      "oneOf" : [ {
        "type" : "string",
        "enum" : [ "fullTime", "partTime" ]
      }, {
        "type" : "string",
        "maxLength" : 0
      } ]
    },
    "appliedOn" : {
      "title" : "Applied On",
      "description" : "The date the application was submitted.",
      "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
      } ]
    },
    "admittedOn" : {
      "title" : "Admitted On",
      "description" : "The earliest admit date for this application.",
      "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
      } ]
    },
    "matriculatedOn" : {
      "title" : "Matriculated On",
      "description" : "The earliest date for a decision/status that would trigger a move to student for this application.",
      "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
      } ]
    },
    "withdrawal" : {
      "title" : "Withdrawal",
      "description" : "Application withdrawal related information.",
      "type" : "object",
      "properties" : {
        "withdrawnOn" : {
          "title" : "Withdrawn On",
          "description" : "The date when the application was withdrawn.",
          "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
          } ]
        },
        "reason" : {
          "title" : "Reason",
          "description" : "The application withdrawal reason.",
          "oneOf" : [ {
            "type" : "object",
            "properties" : {
              "id" : {
                "title" : "ID",
                "description" : "The global identifier for the Reason.",
                "type" : "string",
                "format" : "guid",
                "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
              }
            },
            "links" : [ {
              "rel" : "self",
              "href" : "/admission-application-withdrawal-reasons/{id}",
              "targetSchema" : {
                "$ref" : "admission-application-withdrawal-reasons.json#"
              }
            } ],
            "additionalProperties" : false,
            "required" : [ "id" ]
          }, {
            "type" : "object",
            "maxProperties" : 0
          } ]
        },
        "institutionAttended" : {
          "title" : "Institution Attended",
          "description" : "The institution attended by the applicant.",
          "oneOf" : [ {
            "type" : "object",
            "properties" : {
              "id" : {
                "title" : "ID",
                "description" : "The global identifier for the Institution Attended.",
                "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
          } ]
        }
      },
      "additionalProperties" : false
    },
    "comment" : {
      "title" : "Comment",
      "description" : "The comment associated with the application",
      "type" : "string"
    }
  },
  "required" : [ "id", "applicant", "applicationAcademicPrograms" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/admission-applications?criteria={\"applicant\": {\"id\": $id}}",
    "title" : "Applicant",
    "description" : "The person applying for the admission.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "applicant" : {
          "type" : "object",
          "properties" : {
            "id" : {
              "type" : "string",
              "format" : "guid",
              "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
            }
          }
        }
      }
    },
    "targetSchema" : {
      "$ref" : "admission-applications.json#"
    }
  }, {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/admission-applications?criteria={\"academicPeriod\": {\"id\": $id}}",
    "title" : "Academic Period",
    "description" : "The starting academic period for the admission.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "academicPeriod" : {
          "type" : "object",
          "properties" : {
            "id" : {
              "type" : "string",
              "format" : "guid",
              "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
            }
          }
        }
      }
    },
    "targetSchema" : {
      "$ref" : "admission-applications.json#"
    }
  }, {
    "rel" : "namedQuery",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/admission-applications?personFilter={\"personFilter\": {\"id\": $id}}",
    "name" : "personFilter",
    "title" : "Person Filter",
    "description" : "Retrieve information for a specified population.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "personFilter" : {
          "type" : "string",
          "format" : "guid",
          "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
        }
      }
    },
    "targetSchema" : {
      "$ref" : "admission-applications.json#"
    }
  } ]
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy