eedm.prospect-opportunities.v16.0.0.prospect-opportunities.json Maven / Gradle / Ivy
{
"title" : "Prospect Opportunities",
"description" : "The opportunities for a prospective student at an institution.",
"version" : "16.0.0",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "ID",
"description" : "The global identifier of the prospect opportunity.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"prospect" : {
"title" : "Prospect",
"description" : "The person who is interested in attending the institution.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Prospect.",
"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" ]
},
"recruitAcademicPrograms" : {
"title" : "Recruit Academic Programs",
"description" : "The person who is interested in attending the institution and the academic program(s) they are considering at the institution.",
"type" : "array",
"minItems" : 1,
"items" : {
"title" : "Recruit Academic Programs",
"description" : "The person who is interested in attending the institution and the academic program(s) they are considering at the institution.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Recruit 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" ]
}
},
"entryAcademicPeriod" : {
"title" : "Entry Academic Period",
"description" : "The academic period the prospect is interested in beginning attendance at the institution.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Entry 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
} ]
},
"admissionPopulation" : {
"title" : "Admission Population",
"description" : "The admission population the prospect would be included within at the institution if they attend the institution.",
"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) the prospect is considering.",
"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
} ]
},
"opportunitySource" : {
"title" : "Opportunity Source",
"description" : "The source associated with the prospect opportunity.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Opportunity Source.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/prospect-opportunity-sources/{id}",
"targetSchema" : {
"$ref" : "prospect-opportunity-sources.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"educationalGoal" : {
"title" : "Educational Goal",
"description" : "The educational goal associated with the prospect opportunity.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Educational Goal.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/educational-goals/{id}",
"targetSchema" : {
"$ref" : "educational-goals.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"careerGoals" : {
"title" : "Career Goals",
"description" : "The career goals associated with the prospect opportunity.",
"type" : "array",
"items" : {
"title" : "Career Goals",
"description" : "The career goals associated with the prospect opportunity.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Career Goals.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/career-goals/{id}",
"targetSchema" : {
"$ref" : "career-goals.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
}
},
"required" : [ "id", "prospect", "recruitAcademicPrograms" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/prospect-opportunities?criteria={\"prospect\": {\"id\": $id}}",
"title" : "Prospect",
"description" : "The person who is interested in attending the institution.",
"schema" : {
"type" : "object",
"properties" : {
"prospect" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "prospect-opportunities.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/prospect-opportunities?criteria={\"entryAcademicPeriod\": {\"id\": $id}}",
"title" : "Entry Academic Period",
"description" : "The academic period the prospect is interested in beginning attendance at the institution.",
"schema" : {
"type" : "object",
"properties" : {
"entryAcademicPeriod" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "prospect-opportunities.json#"
}
}, {
"rel" : "namedQuery",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/prospect-opportunities?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" : "prospect-opportunities.json#"
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy