Program Information Exchange - For JSON
- Ian Christopher (Deactivated)
- I. Christopher
Owned by Ian Christopher (Deactivated)
THIS SITE DOCUMENTS A PREVIOUS VERSION. The most recent version is documented here.
This page contains a working draft of the NSPA Scholarship Program Information Data Exchange for JSON specification plus a sample record conformant to the specification. As of v1.0d, the schema is aligned with the JSON Schema draft-07 specification.
Contents:
JSON Sample Record
The listing below shows a sample JSON record for a "typical" scholarship program. The listing validates against the JSON schema below.
Program Information Exchange - JSON Example
{
"ScholarshipProgramCollection": {
"ScholarshipApplicationInfo": [
{
"ProgramOrganizationName": "Anytown Community Foundation",
"ProgramReferenceId": "cfc0fac3-5d0d-4c0d-b1ec-b25c47e1ecc4",
"AdditionalAssociatedOrganizations": {
"OrganizationName": "Michael & Susan Dell Foundation",
"OrganizationReferenceId": "bea2080f-7638-4834-ac44-fd0de0df4f4d",
"OrganizationType": "Private Foundation",
"OrganizationRole": [
"Program Administrator",
"Program Funder"
]
},
"ApplicationCycle": "2019-2020",
"LastVerifiedOn": "2019-03-10",
"LastVerifiedBy": "NSPA Exchange / JR",
"ProgramName": "NSPA Exchange Example Scholarship Program",
"ProgramCommonName": "Example Scholars",
"ProgramURL": "https://www.example.com/sesp-info/",
"ApplicationURL": "https://app.example.com/go-apply/",
"ProgramContact": {
"NameOrDepartment": "Foundation Program Office",
"Email": "programs@example.org"
},
"OpenDate": "2019-10-01",
"CloseDate": "2019-12-31",
"AnnouncementDate": "2020-02-01",
"ScholarshipMaximumAward": 10000,
"AwardDuration": {"AwardDurationType": "One-Time"},
"IsNeedBased": true,
"IsMeritBased": false,
"ProgramCategories": {"ProgramCategory": "Academic"},
"Blurb": "The Snapp Example Scholarship Program serves the financial needs of sample, example, and other irreal children.",
"EligibilityCriteriaDescription": "Students applying for this scholarship must be fictional. Note that characters who solely exist in Harry Potter fan-fiction are not eligible.",
"EligibilityCriteria": {
"Academics": [
{
"AcademicEligibility": "Minimum Overall SAT",
"AcademicEligibilityValue": 750
},
{
"AcademicEligibility": "Minimum GPA",
"AcademicEligibilityValue": 3.2
}
],
"Age": {"MaximumAge": 24},
"CitizenshipStatuses": [
"U.S. Citizen",
"Permanent Resident"
],
"CollegeAttendanceCriteria": [
{
"College": {
"SchoolName": "The University of California at Santa Cruz",
"CEEBCode": "4860",
"SchoolType": "College",
"SchoolAddress": {
"City": "Santa Cruz",
"StateOrProvince": "California",
"Country": "US"
}
}
},
{
"College": {
"SchoolName": "The University of Texas at Austin",
"CEEBCode": "6882",
"SchoolType": "College",
"SchoolAddress": {
"City": "Austin",
"StateOrProvince": "Texas",
"Country": "US"
}
}
}
],
"DegreeSeeking": "Bachelor's Degree",
"Demographics": [
"Female",
"Hispanic"
],
"FieldsOfStudy": [
{
"FieldName": "Art",
"CIPCode": "50.01"
},
{
"FieldName": "Music",
"CIPCode": "50.09"
}
],
"FinancialInformation": {
"FinancialEligibilityAmount": 5000,
"FinancialEligibilityCriteria": "Maximum EFC"
},
"GraduationStatuses": {"GraduationStatus": "Graduating High School Senior"},
"Locations": [
{
"State": "California",
"Country": "US"
},
{
"State": "Texas",
"Country": "US"
}
]
},
"PreferenceCriteria": {
"Profession": {
"Profession": "Accountant",
"IsCurrentProfession": false
}
}
}
]
}
}JSON Schema
The JSON Schema below is aligned with Draft-07 of the JSON Schema specification.
Program Information Exchange - JSON Schema (JSON Schema Draft-07)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"ScholarshipProgramCollection": {"$ref": "#/definitions/ScholarshipProgramCollection"}
},
"definitions": {
"ScholarshipProgramCollection": {
"description": "The primary entry for a scholarship program",
"type": "object",
"properties": {
"ScholarshipApplicationInfo": {
"anyOf": [
{"$ref": "#/definitions/ScholarshipProgram"},
{
"type": "array",
"minItems": 1,
"items": {"$ref": "#/definitions/ScholarshipProgram"}
}
]
}
},
"required": ["ScholarshipApplicationInfo"]
},
"ScholarshipPrograms": {
"$ref": "#/definitions/xs:anyType",
"description": "The root scholarship program entity"
},
"ScholarshipProgram": {
"description": "A single scholarship offering and its eligibility criteria",
"type": "object",
"properties": {
"ProgramOrganizationName": {
"$ref": "#/definitions/ShortString",
"description": "The name of the organization sponsoring the program (e.g., the Michael & Susan Dell Foundation sponsors the Dell Scholars Program)"
},
"ProgramReferenceId": {
"$ref": "#/definitions/ShortString",
"description": "The ID the organization supplying the program information uses to uniquely identify the program. If the reference ID matches one previously supplied by this organization, the existing data will be updated (replaced by) the new information. There are no restrictions on the format of this id; it can be a number, a GUID, etc. It is simply matched as-is."
},
"AdditionalAssociatedOrganizations": {
"anyOf": [
{"$ref": "#/definitions/AssociatedOrganizations"},
{
"type": "array",
"maxItems": 4,
"items": {"$ref": "#/definitions/AssociatedOrganizations"}
}
],
"description": "An optional list of additional organizations related to this program. Used to indicate associations such as the community foundation administering the program or the hosting service for the program's online application. These additional organizations are provided for informational purposes only, and should not be used to infer eligibility or an application URL."
},
"ApplicationCycle": {
"$ref": "#/definitions/ShortString",
"description": "The scholarship application cycle during which this program was accepting applications. Should be formatted as a school academic year (e.g., 2019-2020). Usually precedes the academic year in which the award will be used (e.g., awards in the 2019-2020 application cycle will typically be used in the 2020-2021 academic year)."
},
"LastVerifiedOn": {
"$ref": "#/definitions/xs:date",
"description": "The most recent date on which the scholarship program information was verified by a human. Null indicates that the information has never been formally verified."
},
"LastVerifiedBy": {
"$ref": "#/definitions/ShortString",
"description": "The entity or organization that most recently verified the scholarship program information. May include both an organization name and an identifier for an individual (e.g., 'NSPA Exchange / JR'). Organizations sharing data should be consistent about their own name."
},
"ProgramName": {
"$ref": "#/definitions/MediumString",
"description": "The full name of the program"
},
"ProgramCommonName": {
"$ref": "#/definitions/ShortString",
"description": "A common name, nickname, abbreviated name, or other alternate name for the program (e.g., Dell Scholarship, Coke Scholars)"
},
"ProgramURL": {
"$ref": "#/definitions/LongString",
"description": "The web page address for program information. By convention, should be specific to the scholarship program, not a general organization home page."
},
"ApplicationURL": {
"$ref": "#/definitions/LongString",
"description": "The web page address for the online application, if any"
},
"ProgramContact": {
"$ref": "#/definitions/ProgramContact",
"description": "A public contact, if any, for the program. By convention, empty if no specific and public information is provided by the program organization."
},
"OpenDate": {
"$ref": "#/definitions/xs:date",
"description": "The open date of the application. By convention, the next open date in the application cycle (or the already passed open date in the current application cycle)."
},
"CloseDate": {
"$ref": "#/definitions/xs:date",
"description": "The closing date of the application. By convention, the next closing date in the application cycle (or an already passed closing date in the current application cycle)."
},
"AnnouncementDate": {
"$ref": "#/definitions/xs:date",
"description": "The date scholarship awards are announced. Typically, the date the announcement notification is made to applicants. May be the date recipients are posted on a public website if the notification date is unknown. By convention, the next announcement date in the application cycle (or an already passed announcement date in the current application cycle)."
},
"ScholarshipMaximumAward": {
"$ref": "#/definitions/xs:decimal",
"description": "If the scholarship provides a range, the maximum of the range. If the scholarship only awards one amount, this amount should be populated."
},
"ScholarshipMinimumAward": {
"$ref": "#/definitions/xs:decimal",
"description": "If the scholarship provides a range, the minimum of the range. By convention, not present if the scholarship awards a single amount."
},
"AwardDuration": {
"$ref": "#/definitions/AwardDuration",
"description": "The duration in which a scholarship award may be used. Indicates the number of years for a multiyear program, or the number of renewals for a renewable program."
},
"NumberOfScholarshipsAwarded": {
"$ref": "#/definitions/xs:integer",
"description": "The number of scholarships awarded by this program in a given cycle (generally between the open date and close date). If no date range specified, the NSPA Exchange assumes a 12-month cycle."
},
"IsNeedBased": {
"$ref": "#/definitions/xs:boolean",
"description": "Indicator of whether or not the scholarship is need-based"
},
"IsMeritBased": {
"$ref": "#/definitions/xs:boolean",
"description": "Indicator of whether or not the scholarship is merit-based"
},
"IsContest": {
"$ref": "#/definitions/xs:boolean",
"description": "Indicator of whether or not the scholarship award is based on a contest or prize. These typically have few eligibility criteria. If true, contest or prize details should appear in the Blurb or Eligibility Criteria Detail elements."
},
"ProgramCategories": {
"anyOf": [
{"$ref": "#/definitions/ProgramCategories"},
{
"type": "array",
"maxItems": 4,
"items": {"$ref": "#/definitions/ProgramCategories"}
}
],
"description": "The general category or categories of the scholarship program. These are broad categories such as Academic, First Generation, Transfer Student, and so forth. Note that categories are often reflected or can be inferred by data elsewhere in the model (e.g., the Transfer Student category can be inferred by current grade and degree being sought and/or membership in an organization supporting transfer students)."
},
"Blurb": {
"$ref": "#/definitions/LongString",
"description": "A short description of the scholarship program. Can include markdown. Should not include HTML or markup."
},
"ProgramSelfDescription": {
"$ref": "#/definitions/LongString",
"description": "A short description of the program as described by the program or hosting organization itself. Analogous to the Blurb, but self-reported or based on original text. Can include markdown. Should not include HTML or markup."
},
"EligibilityCriteriaDescription": {
"$ref": "#/definitions/LongString",
"description": "An optional, human-readable Eligibility Criteria for the program. Usually present when the eligibility criteria for the program are not easily described or can't be encoded in the structured Eligibility Criteria element. Not necessarily inclusive of all criteria."
},
"AwardVerificationCriteriaDescription": {
"$ref": "#/definitions/LongString",
"description": "An optional list of verifications (e.g., proof of citizenship, tax return, Student Aid Report) required for the scholarship program. Typically entered if publicly available or supplied by program staff."
},
"AllowedFundingUseDescription": {
"$ref": "#/definitions/LongString",
"description": "An optional list of purposes for which the scholarship award may be used (e.g., tuition, books, living expenses, travel). Typically present if publicly available or supplied by program staff."
},
"LogoFile": {
"$ref": "#/definitions/xs:base64Binary",
"description": "An image of a logo file in MIME base64 encoding. By convention, constrained to PNG, JPG, GIF file types."
},
"LogoFileName": {
"$ref": "#/definitions/ShortString",
"description": "A file name for the logo. The name should include the file extension indicating type (e.g., .png, .jpg, .gif)."
},
"EligibilityCriteria": {
"$ref": "#/definitions/EligibilityCriteria",
"description": "A set of eligibility criteria for this scholarship program"
},
"PreferenceCriteria": {
"$ref": "#/definitions/EligibilityCriteria",
"description": "A set of eligibility preferences for this scholarship program. Preference Criteria indicate stated preferences that are not mandatory for an applicant to be eligible for the program. By definition, mirrors the structure of Eligibility Criteria exactly. Contrast with the Eligibility Criteria which are mandatory."
}
},
"required": ["ProgramName"]
},
"AcademicEligibility": {
"description": "Academic and test information used to determine scholarship eligibility or qualification",
"type": "object",
"properties": {
"AcademicEligibility": {
"$ref": "#/definitions/AcademicEligibilityCriteriaList",
"description": "The type of academic eligibility criteria"
},
"AcademicEligibilityValue": {
"$ref": "#/definitions/xs:decimal",
"description": "A numeric value representing a score or academic average"
}
},
"required": [
"AcademicEligibility",
"AcademicEligibilityValue"
]
},
"ActivityEligibility": {
"description": "An activity, including a sport, hobby, avocation, or similar active pursuit. Contrast with Interest, which represents an enjoyment or spectator role.",
"type": "object",
"properties": {
"Activity": {
"$ref": "#/definitions/ShortString",
"description": "The activity in question. The activity in question. Values are defined by the NSPA Activity list."
},
"ActivityOther": {
"$ref": "#/definitions/ShortString",
"description": "Free-text name of the activity if 'Other' Activity is indicated"
}
},
"required": ["Activity"]
},
"Address": {
"description": "An address for a person or organization in a standard format",
"type": "object",
"properties": {
"AddressLine1": {
"$ref": "#/definitions/ShortString",
"description": "The first line of the street address"
},
"AddressLine2": {
"$ref": "#/definitions/ShortString",
"description": "The second line of the street address"
},
"City": {
"$ref": "#/definitions/ShortString",
"description": "The address city"
},
"StateOrProvince": {
"$ref": "#/definitions/ShortString",
"description": "The name of the state or province for the address (e.g., British Columbia, California, Durango)"
},
"ZipOrPostalCode": {
"$ref": "#/definitions/ShortString",
"description": "The address zip code or postal code"
},
"Country": {
"$ref": "#/definitions/ShortString",
"description": "An ISO 3166-1 2-letter country code (e.g., CA, MX, US). Should be present for any entries with location criteria, but may be inferred from State or system context. Assumed to be 'US' if not present."
}
}
},
"AffiliationEligibility": {
"description": "An affiliation or other relationship to an organization or entity",
"type": "object",
"properties": {
"AffiliationEntity": {
"$ref": "#/definitions/ShortString",
"description": "The proper-noun name of the organization or entity to which the relationship applies. Defined by the NSPA Affiliation Entity list."
},
"AffiliationEntityOther": {
"$ref": "#/definitions/ShortString",
"description": "Free-text name of the affiliated entity if 'Other' AffiliationEntity is indicated"
},
"DirectRelation": {
"$ref": "#/definitions/RelationList",
"description": "The primary, direct relationship to an organization or entity (e.g., Employee Of, Member Of)"
},
"IndirectRelation": {
"$ref": "#/definitions/RelationList",
"description": "An optional, indirect relation. Used to indicate, for example, the Child Of an Employee Of an organization. The \"Child Of\" is, of course, the indirect relation."
}
},
"required": [
"AffiliationEntity",
"DirectRelation"
]
},
"AgeEligibility": {
"description": "Minimum and maximum age requirements for the program. Only used when age is notable and specifically indicated by the program. For the majority of programs, Current Grade Level is used as a proxy for age requirements.",
"type": "object",
"properties": {
"MinimumAge": {
"$ref": "#/definitions/xs:integer",
"description": "The minimum age requirement, in years, for the program. Inclusive (i.e., indicates NN years and older)."
},
"MaximumAge": {
"$ref": "#/definitions/xs:integer",
"description": "The maximum age requirement, in years, for the program. Inclusive (i.e., indicates NN years and younger)."
}
}
},
"ApplicationRestrictionEligibility": {
"description": "A restriction for applying to this scholarship program (e.g., indicating the application is by invitation only). Details should be provided in the Blurb or Eligibility Criteria Detail elements.",
"type": "object",
"properties": {
"ApplicationRestriction": {
"$ref": "#/definitions/ApplicationRestrictionList",
"description": "The restriction for an application"
}
}
},
"ArmedServicesEligibility": {
"description": "A bundle of Armed Services criteria",
"type": "object",
"properties": {
"ArmedServiceBranch": {
"anyOf": [
{
"$ref": "#/definitions/ArmedServicesList",
"description": "The armed service that determines eligibility. No value combined with other armed service elements assumes all services apply."
},
{
"type": "array",
"items": {
"$ref": "#/definitions/ArmedServicesList",
"description": "The armed service that determines eligibility. No value combined with other armed service elements assumes all services apply."
}
}
]
},
"ArmedServiceRelation": {
"anyOf": [
{
"$ref": "#/definitions/ArmedServicesRelationList",
"description": "The relation to an armed servicemember. No value assumes that the scholarship is for the servicemember."
},
{
"type": "array",
"items": {
"$ref": "#/definitions/ArmedServicesRelationList",
"description": "The relation to an armed servicemember. No value assumes that the scholarship is for the servicemember."
}
}
]
},
"ArmedServiceStatus": {
"anyOf": [
{
"$ref": "#/definitions/ArmedServicesStatusList",
"description": "The armed service duty status determines eligibility. No value assumes all statuses apply."
},
{
"type": "array",
"items": {
"$ref": "#/definitions/ArmedServicesStatusList",
"description": "The armed service duty status determines eligibility. No value assumes all statuses apply."
}
}
]
}
}
},
"AssociatedOrganizations": {
"anyOf": [
{"$ref": "#/definitions/Organization"},
{
"type": "array",
"items": {"$ref": "#/definitions/Organization"}
}
]
},
"AwardDuration": {
"description": "The period of time over which a scholarship award may be used or renewed",
"type": "object",
"properties": {
"AwardDurationType": {
"$ref": "#/definitions/AwardDurationTypeList",
"description": "The type of award duration (e.g., Multiyear, Renewable)"
},
"DurationYears": {
"$ref": "#/definitions/xs:decimal",
"description": "The duration, in years, of the scholarship award (when 'Multiyear' is indicated) or the number of allowed renewals (when 'Renewable' is indicated). Should typically be an integer, may be a decimal to indicate partial year durations."
}
},
"required": ["AwardDurationType"]
},
"CollegeReadinessProgramParticipation": {
"description": "Participation or membership in a college readiness program",
"type": "object",
"properties": {
"CollegeReadinessProgram": {
"$ref": "#/definitions/ShortString",
"description": "The college readiness program in which the applicant participated. Defined by the NSPA College Readiness Program list."
},
"CollegeReadinessProgramDesc": {
"$ref": "#/definitions/ShortString",
"description": "Free-text name of the college readiness program when the 'Other' CollegeReadinessProgram is selected"
}
},
"required": ["CollegeReadinessProgram"]
},
"CollegeAttendanceCriteria": {
"description": "College attendance eligibility criteria. Senders should supply either an NCES or CEEB code wherever possible. Implementations will typically try to match names without the codes, but will not include the college if no match is found.",
"type": "object",
"properties": {
"College": {
"$ref": "#/definitions/School",
"description": "The college at which a student must attend to be eligible for a scholarship"
}
},
"required": ["College"]
},
"ConditionCriteria": {
"description": "A condition, usually medical or physical, for which a scholarship is intended. Not necessarily a disability (e.g., Left Handedness).",
"type": "object",
"properties": {
"Condition": {
"$ref": "#/definitions/ShortString",
"description": "The condition in question. Values are defined by the NSPA Condition Criteria list."
},
"ConditionOther": {
"$ref": "#/definitions/ShortString",
"description": "Free-text name of the condition if 'Other' Condition is indicated"
}
},
"required": ["Condition"]
},
"CurrentSchoolCriteria": {
"description": "Any restrictions on the current high school, college, or education institution. Indicates, for example, programs that serve graduates of a certain high school or current underclassmen at a specific college. Senders should supply either an NCES or CEEB code wherever possible. Receiving systems will typically try to match names without the codes, but will not include the school if no match is found.",
"type": "object",
"properties": {
"School": {
"$ref": "#/definitions/School",
"description": "The school or college the applicant is currently attending"
}
},
"required": ["School"]
},
"EligibilityCriteria": {
"description": "The set of eligibility criteria such as minimum GPA, location, and so forth.",
"type": "object",
"properties": {
"Academics": {
"anyOf": [
{"$ref": "#/definitions/AcademicEligibility"},
{
"type": "array",
"items": {"$ref": "#/definitions/AcademicEligibility"}
}
]
},
"Activity": {
"anyOf": [
{"$ref": "#/definitions/ActivityEligibility"},
{
"type": "array",
"items": {"$ref": "#/definitions/ActivityEligibility"}
}
]
},
"Affiliation": {
"anyOf": [
{"$ref": "#/definitions/AffiliationEligibility"},
{
"type": "array",
"items": {"$ref": "#/definitions/AffiliationEligibility"}
}
]
},
"Age": {"$ref": "#/definitions/AgeEligibility"},
"ApplicationRestriction": {
"anyOf": [
{"$ref": "#/definitions/ApplicationRestrictionEligibility"},
{
"type": "array",
"items": {"$ref": "#/definitions/ApplicationRestrictionEligibility"}
}
]
},
"ArmedServices": {
"anyOf": [
{"$ref": "#/definitions/ArmedServicesEligibility"},
{
"type": "array",
"items": {"$ref": "#/definitions/ArmedServicesEligibility"}
}
]
},
"CitizenshipStatuses": {
"anyOf": [
{"$ref": "#/definitions/USCitizenshipStatusEligibilityCriteriaList"},
{
"type": "array",
"items": {"$ref": "#/definitions/USCitizenshipStatusEligibilityCriteriaList"}
}
]
},
"CollegeAttendanceCriteria": {
"anyOf": [
{"$ref": "#/definitions/CollegeAttendanceCriteria"},
{
"type": "array",
"items": {"$ref": "#/definitions/CollegeAttendanceCriteria"}
}
]
},
"CollegeReadinessProgramParticipation": {
"anyOf": [
{"$ref": "#/definitions/CollegeReadinessProgramParticipation"},
{
"type": "array",
"items": {"$ref": "#/definitions/CollegeReadinessProgramParticipation"}
}
]
},
"Condition": {
"anyOf": [
{"$ref": "#/definitions/ConditionCriteria"},
{
"type": "array",
"items": {"$ref": "#/definitions/ConditionCriteria"}
}
]
},
"CurrentGradeLevel": {
"anyOf": [
{"$ref": "#/definitions/GradeLevel"},
{
"type": "array",
"items": {"$ref": "#/definitions/GradeLevel"}
}
]
},
"CurrentSchool": {
"anyOf": [
{"$ref": "#/definitions/CurrentSchoolCriteria"},
{
"type": "array",
"items": {"$ref": "#/definitions/CurrentSchoolCriteria"}
}
]
},
"DegreeSeeking": {
"anyOf": [
{"$ref": "#/definitions/DegreeSeekingCriteriaList"},
{
"type": "array",
"items": {"$ref": "#/definitions/DegreeSeekingCriteriaList"}
}
]
},
"Demographics": {
"anyOf": [
{"$ref": "#/definitions/ShortString"},
{
"type": "array",
"items": {"$ref": "#/definitions/ShortString"}
}
]
},
"FieldsOfStudy": {
"anyOf": [
{"$ref": "#/definitions/FieldOfStudy"},
{
"type": "array",
"items": {"$ref": "#/definitions/FieldOfStudy"}
}
]
},
"FinancialInformation": {
"anyOf": [
{"$ref": "#/definitions/EligibilityFinancialInformation"},
{
"type": "array",
"items": {"$ref": "#/definitions/EligibilityFinancialInformation"}
}
]
},
"GraduationStatuses": {
"anyOf": [
{"$ref": "#/definitions/GraduationStatusCriteria"},
{
"type": "array",
"items": {"$ref": "#/definitions/GraduationStatusCriteria"}
}
]
},
"Interests": {
"anyOf": [
{"$ref": "#/definitions/InterestCriteria"},
{
"type": "array",
"items": {"$ref": "#/definitions/InterestCriteria"}
}
]
},
"Locations": {
"anyOf": [
{"$ref": "#/definitions/EligibilityLocation"},
{
"type": "array",
"items": {"$ref": "#/definitions/EligibilityLocation"}
}
]
},
"Miscellaneous": {
"anyOf": [
{"$ref": "#/definitions/MiscellaneousCriteria"},
{
"type": "array",
"items": {"$ref": "#/definitions/MiscellaneousCriteria"}
}
]
},
"Profession": {
"anyOf": [
{"$ref": "#/definitions/ProfessionCriteria"},
{
"type": "array",
"items": {"$ref": "#/definitions/ProfessionCriteria"}
}
]
},
"Situation": {
"anyOf": [
{"$ref": "#/definitions/SituationCriteria"},
{
"type": "array",
"items": {"$ref": "#/definitions/SituationCriteria"}
}
]
}
}
},
"EligibilityFinancialInformation": {
"description": "Financial information used to determine scholarship eligibility or qualification.",
"type": "object",
"properties": {
"FinancialEligibilityAmount": {
"$ref": "#/definitions/xs:decimal",
"description": "An amount related to the financial eligibility or qualification"
},
"FinancialEligibilityCriteria": {
"$ref": "#/definitions/FinancialEligibilityCriteriaList",
"description": "The type of financial eligibility or qualification"
}
},
"required": [
"FinancialEligibilityAmount",
"FinancialEligibilityCriteria"
]
},
"EligibilityLocation": {
"description": "A location used to determine scholarship eligibility or qualification",
"type": "object",
"properties": {
"City": {
"$ref": "#/definitions/ShortString",
"description": "A city name, if considered in determining eligibility. By convention, in the U.S."
},
"County": {
"$ref": "#/definitions/ShortString",
"description": "A county name, if considered in determining eligibility. By convention, a U.S. county name, not abbreviated, not including the word 'County.'"
},
"State": {
"$ref": "#/definitions/ShortString",
"description": "A state name, if considered in determining eligibility. Should be present if City and/or County is present. By convention, a U.S. state name, not abbreviated."
},
"Country": {
"$ref": "#/definitions/ShortString",
"description": "An ISO 3166-1 2-letter country code (e.g., CA, MX, US). Should be present for any entries with location criteria, but may be inferred from State or system context. Assumed to be 'US' if not present."
}
}
},
"FieldOfStudy": {
"description": "The college major or field of study a program supports",
"type": "object",
"properties": {
"CIPCode": {
"$ref": "#/definitions/ShortString",
"description": "The NCES/IPEDS Classification of Instructional Programs (CIP) code for the field of study. Sending applications should include this where possible, but receiving systems will typically perform a text match on the field name, if necessary."
},
"FieldName": {
"$ref": "#/definitions/ShortString",
"description": "The common name of a field of study (e.g., Agriculture, English Literature)"
}
},
"required": ["FieldName"]
},
"GradeLevel": {
"description": "The current grade level",
"type": "object",
"properties": {
"CurrentGrade": {
"anyOf": [
{
"$ref": "#/definitions/GradeLevelList",
"description": "The current grade level requirement"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/GradeLevelList",
"description": "The current grade level requirement"
}
}
]
}
}
},
"GraduationStatusCriteria": {
"description": "Graduation and alumnus eligibility criteria. Senders should supply an NCES or CEEB code wherever possible. Receiving systems will typically try to match names without the codes, but will not include the college if no match is found.",
"type": "object",
"properties": {
"GraduationStatus": {
"$ref": "#/definitions/GraduationStatusCriteriaList",
"description": "The degree or other graduation status"
},
"SchoolName": {
"$ref": "#/definitions/School",
"description": "The school for which the status applies. If a degree is indicated in Graduation Status, this indicates the student must be an alumnus of the particular school or institution."
}
}
},
"InterestCriteria": {
"description": "Interest qualifying criteria for the scholarship. Denotes an appreciation or enthusiasm for a subject. Contrast with Activity which indicates active participation or performance.",
"type": "object",
"properties": {
"InterestCriteria": {
"$ref": "#/definitions/ShortString",
"description": "The interest criteria in question. Values are defined by the NSPA Interest Criteria list."
},
"InterestOther": {
"$ref": "#/definitions/ShortString",
"description": "Free-text name of the interest criteria if 'Other' InterestCriteria is indicated"
}
},
"required": ["InterestCriteria"]
},
"MiscellaneousCriteria": {
"description": "Miscellaneous qualifying criteria for the scholarship",
"type": "object",
"properties": {
"MiscellaneousCriteria": {
"$ref": "#/definitions/ShortString",
"description": "The miscellaneous criteria in question. Values are defined by the NSPA Miscellaneous Criteria list."
},
"MiscellaneousOther": {
"$ref": "#/definitions/ShortString",
"description": "Free-text name of the miscellaneous criteria if 'Other' MiscellaneousCriteria is indicated. 'Other' here will be truly esoteric, and will only be matched by prior arrangement."
}
},
"required": ["MiscellaneousCriteria"]
},
"Organization": {
"description": "Information about organizations affiliated with a program. Includes a type, a logo, and other details.",
"type": "object",
"properties": {
"OrganizationName": {
"$ref": "#/definitions/ShortString",
"description": "The associated organization name"
},
"OrganizationReferenceId": {
"$ref": "#/definitions/ShortString",
"description": "The ID the organization supplying the program information uses to uniquely identify the program. If the reference ID matches one previously supplied by this organization, the existing data will be updated (replaced by) the new information. There are no restrictions on the format of this id; it can be a number, a GUID, etc. It is simply matched as-is."
},
"OrganizationType": {
"$ref": "#/definitions/OrganizationTypeList",
"description": "The type of associated organization (e.g., Community Foundation, Hosting Service)"
},
"OrganizationRole": {
"anyOf": [
{"$ref": "#/definitions/OrganizationRoleList"},
{
"type": "array",
"items": {"$ref": "#/definitions/OrganizationRoleList"}
}
],
"description": "The roles played by the organization in relation to the program (e.g., Program Funder, Application Hosting Service Provider)"
},
"LogoFile": {
"$ref": "#/definitions/xs:base64Binary",
"description": "An image of a logo file in MIME base64 encoding. By convention, constrained to PNG, JPG, GIF file types."
},
"LogoFileName": {
"$ref": "#/definitions/ShortString",
"description": "A file name for the logo. The name should include the file extension indicating type (e.g., .png, .jpg, .gif)."
}
},
"required": ["OrganizationName"]
},
"ProfessionCriteria": {
"description": "A profession or vocation a program supports",
"type": "object",
"properties": {
"Profession": {
"$ref": "#/definitions/ShortString",
"description": "The name of the profession in question. Values are defined by the NSPA Profession Criteria list."
},
"ProfessionOther": {
"$ref": "#/definitions/ShortString",
"description": "Free-text name of the profession if 'Other' CurrentProfession is indicated. By convention, includes an SOCCode where possible."
},
"SOCCode": {
"$ref": "#/definitions/ShortString",
"description": "The Standard Occupational Classification (SOC) code for the profession, maintained by the U.S. Government. By convention, aligns with the SOC 2018 standard published November 2017. Generally used if 'Other' CurrentProfession is selected."
},
"IsCurrentProfession": {
"type": "boolean",
"description": "An indicator whether the profession must be an applicant's current profession. If true, indicates that the applicant must currently be working in the field. If not present or false, indicates that the profession is a goal or future intention."
}
},
"required": ["Profession"]
},
"ProgramCategories": {
"description": "The categories indicating a broad type of scholarship program (e.g., Academic, Contest, First-Generation)",
"type": "object",
"properties": {
"ProgramCategory": {
"$ref": "#/definitions/ShortString",
"description": "The program category. Values are defined by the NSPA Program Category list."
},
"ProgramCategoryOther": {
"$ref": "#/definitions/ShortString",
"description": "Free-text name of the category if 'Other' Program Category is indicated"
}
},
"required": ["ProgramCategory"]
},
"ProgramContact": {
"description": "Public contact information related to this program. Generally empty if not specifically provided by the offering organization for the scholarship or scholarship program. Should not contain personal or private contact information.",
"type": "object",
"properties": {
"NameOrDepartment": {
"$ref": "#/definitions/ShortString",
"description": "The program category. Values are defined by the NSPA Program Category list."
},
"Email": {
"$ref": "#/definitions/ShortString",
"description": "Often a general mailbox (e.g., programs@example.com)"
},
"Phone": {
"$ref": "#/definitions/ShortString",
"description": "A phone number for the program contact"
}
}
},
"School": {
"description": "An educational institution such as a High School, College, Trade School, or similar",
"type": "object",
"properties": {
"SchoolName": {
"$ref": "#/definitions/ShortString",
"description": "The official name of the school"
},
"NCESCode": {
"$ref": "#/definitions/ShortString",
"description": "The National Center for Education Statistics (NCES) or Integrated Postsecondary Education Data System (IPEDS) code for the school"
},
"CEEBCode": {
"$ref": "#/definitions/ShortString",
"description": "The College Board registry number for the school"
},
"SchoolType": {
"$ref": "#/definitions/ShortString",
"description": "The type of school (e.g., College, High School). Values are defined by the NSPA School Type list."
},
"SchoolAddress": {
"$ref": "#/definitions/Address",
"description": "The full address of the school"
}
},
"required": ["SchoolName"]
},
"SituationCriteria": {
"description": "An applicant's situation qualifying the applicant for the scholarship. Situations are not necessarily negative (e.g., Mother, Married).",
"type": "object",
"properties": {
"Situation": {
"$ref": "#/definitions/ShortString",
"description": "The situation in question (e.g., Homeless, Migrant, Married)"
},
"SituationOther": {
"$ref": "#/definitions/ShortString",
"description": "Free-text name of the situation if 'Other' Situation is indicated"
}
},
"required": ["Situation"]
},
"ShortString": {
"description": "String used for short text fields",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"MediumString": {
"description": "String used for mid-length text fields",
"type": "string",
"minLength": 1,
"maxLength": 512
},
"LongString": {
"description": "String used for long text fields, such as descriptions",
"type": "string",
"minLength": 1,
"maxLength": 4000
},
"AcademicEligibilityCriteriaList": {
"description": "The list of academic eligibility and qualification criteria. By convention, 'other' values will be ignored unless agreed upon between sender and receiver.",
"type": "string",
"minLength": 1,
"maxLength": 100,
"enum": [
"Minimum GPA",
"Minimum Overall SAT",
"Minimum SAT Math",
"Minimum SAT Evidence-Based Reading and Writing",
"Minimum SAT Essay Reading",
"Minimum SAT Essay Analysis",
"Minimum SAT Essay Writing",
"Minimum ACT Composite",
"Minimum Class Rank Percentage"
]
},
"ApplicationRestrictionList": {
"description": "The list of special restrictions on the application",
"type": "string",
"minLength": 1,
"maxLength": 100,
"enum": [
"Invitation Only",
"Recommendation Only"
]
},
"ArmedServicesList": {
"description": "The list of Armed Services",
"type": "string",
"minLength": 1,
"maxLength": 100,
"enum": [
"Army",
"Navy",
"Air Force",
"Marine Corps",
"Coast Guard",
"National Guard"
]
},
"ArmedServicesRelationList": {
"description": "The list of relations to a member of the armed services. If no relation is present, then assume self. Dependent includes Child. Family includes Dependent and Child.",
"type": "string",
"minLength": 1,
"maxLength": 100,
"enum": [
"Child Of",
"Dependent Of",
"Family Of",
"Grandchild Of",
"Parent Of",
"Spouse Of"
]
},
"ArmedServicesStatusList": {
"description": "The list of Armed Services Statuses",
"type": "string",
"minLength": 1,
"maxLength": 100,
"enum": [
"Active Duty",
"Reserve Duty",
"Veteran",
"Retired",
"POW/MIA",
"KIA"
]
},
"AwardDurationTypeList": {
"description": "The list of Award Duration options",
"type": "string",
"minLength": 1,
"maxLength": 100,
"enum": [
"One-Time",
"Multiyear",
"Renewable"
]
},
"DegreeSeekingCriteriaList": {
"description": "The list of degrees being sought eligibility and qualification criteria",
"type": "string",
"minLength": 1,
"maxLength": 100,
"enum": [
"Professional Certification",
"1-year Certificate",
"Associate's Degree",
"Bachelor's Degree",
"Graduate Degree",
"Doctor of Medicine",
"Law Degree",
"MBA",
"MFA",
"PhD"
]
},
"FinancialEligibilityCriteriaList": {
"description": "The list of financial eligibility and qualification criteria. Most are assumed to be FAFSA amounts, but senders may use the closest equivalent if it's unclear. By convention, 'other' values will be ignored unless agreed upon between sender and receiver.",
"type": "string",
"minLength": 1,
"maxLength": 100,
"enum": [
"Minimum AGI",
"Maximum AGI",
"Minimum EFC",
"Maximum EFC"
]
},
"GradeLevelList": {
"description": "The list of grade level eligibility and qualification criteria. Represents current grade at time of application. Contrast with Graduation Status, which records past promotions and graduations.",
"type": "string",
"minLength": 1,
"maxLength": 100,
"enum": [
"High School Freshman",
"High School Sophomore",
"High School Junior",
"High School Senior",
"Community College Freshman",
"Community College Freshman - Attended College Previously",
"Community College Sophomore",
"College Freshman",
"College Freshman - Attended College Previously",
"College Sophomore",
"College Junior",
"College Senior",
"5th Year College Undergraduate",
"Nth Year College Undergraduate",
"Graduate Student",
"Doctoral Candidate",
"Postgraduate Medical School",
"Postgraduate Law School",
"Not Enrolled",
"On Academic Break"
]
},
"GraduationStatusCriteriaList": {
"description": "The list of graduation status eligibility and qualification criteria.",
"type": "string",
"minLength": 1,
"maxLength": 100,
"enum": [
"Graduating High School Senior",
"GED or High School Equivalency",
"Certificate Program Graduate",
"High School Graduate",
"High School Graduate - No Prior College",
"High School Graduate - No Prior Degrees",
"Community College Freshman",
"Community College Sophomore",
"College Freshman",
"College Sophomore",
"Associate's Degree",
"Bachelor's Degree",
"Graduate Degree"
]
},
"OrganizationRoleList": {
"description": "The list of organization roles in relation to the program",
"type": "string",
"minLength": 1,
"maxLength": 100,
"enum": [
"Application Hosting Service Provider",
"Eligibility - Alumnus Requirement",
"Eligibility - Enrollment Requirement",
"Listing Service",
"Program Administrator",
"Program Funder"
]
},
"OrganizationTypeList": {
"description": "The list of organization types",
"type": "string",
"minLength": 1,
"maxLength": 100,
"enum": [
"College or University",
"Community Foundation",
"High School",
"Hosting Service",
"Private Foundation",
"Trade or Technical School"
]
},
"RelationList": {
"description": "The list of relations. In some uses, may be chained (e.g., Child Of-Employee Of-ExampleCo Inc., which would indicate that children of ExampleCo employees were eligible for the scholarship in question). Dependent includes Child. Family includes Dependent, Child, Parent, and Spouse. Descendant includes Child.",
"type": "string",
"minLength": 1,
"maxLength": 100,
"enum": [
"Child Of",
"Customer Of",
"Dependent Of",
"Descendant Of",
"Employee Of",
"Family Of",
"Member Of",
"Parent Of",
"Spouse Of"
]
},
"USCitizenshipStatusEligibilityCriteriaList": {
"description": "The list of U.S. citizenship eligibility and qualification criteria, roughly aligned with the FAFSA categories plus populations served by known providers. By convention, 'other' values will be ignored unless agreed upon between sender and receiver.",
"type": "string",
"minLength": 1,
"maxLength": 100,
"enum": [
"U.S. Citizen",
"Permanent Resident",
"Conditional Permanent Resident",
"Current DACA Status",
"Pending DACA Application",
"FAFSA-Eligible Non-Citizen",
"Not a U.S. Citizen",
"Asylum-Seeker or Asylee",
"Cuban or Haitian Entrant",
"Humanitarian Parolee",
"Refugee",
"California AB 540",
"Other"
]
},
"xs:anyType": {
"type": [
"object",
"string",
"number",
"boolean"
],
"properties": {
"$": {
"type": [
"string",
"number",
"boolean"
]
}
},
"patternProperties": {
"^@\\w+$": {
"type": [
"string",
"number",
"boolean"
]
},
"^\\w+$": ""
}
},
"xs:base64Binary": {"type": "string"},
"xs:boolean": {"type": "boolean"},
"xs:date": {"type": "string"},
"xs:decimal": {"type": "number"},
"xs:integer": {"type": "integer"}
}
}