- Created by Ian Christopher (Deactivated) , last modified on May 17, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 39 Next »
The final draft of the Scholar Snapp v3.0 data standard for the 2017-2018 application cycle was published on May 15, 2017. The Snapp Central API currently accepts and emits Snapp v2.0, the previous version. Development on the Snapp Central API to accommodate v3.0 is in progress (ETA July/August 2017). We encourage all new integrators to use v3.0.
Overview
The Student entity is where the magic happens: this entity contains information about the student as well as the scholarship application data.
Details
This section contains detail and usage notes about the elements in the Student entity:
Student.Activities
Detail about a student's community service, hobbies, volunteering and other extracurricular activities. Optional.
Supports detail about hours/week and days/month, information about the organization affiliated with the activity, whether the activity was a graduation requirement, and so forth.
Student.ArmedForcesCharacteristics
Characteristics related to armed forces programs, a student's armed forces service record, and other attributes common to armed forces scholarship applications. Optional.
Student.BirthDate
The student's date of birth. Optional.
Student.BirthPlace
The city, state/province, and country where the student was born. The state/province value is the only required value. Optional.
Student.Citizenship
The student's current citizenship status, the status date, and the country to which the status applies. Optional.
Student.ClassRank
A student's class ranking, including the school to which the ranking applies, the system used (e.g., integer, decile).
Note that 1 is highest (so 98th percentile would look awesome in this context).
Student.CollegeReadinessProgram.ProgramName
The Snapp Data Standard has a structured list of common college readiness programs based on the CollegeReadinessProgramList
enumeration. The list was compiled from implementers and desktop research.
- Other. The list includes an "Other" option, in which case sending systems should populate the ProgramOtherDesc element with the name or description of a College Readiness Program not found on the list.
- None. The list includes a "None" option. "None" is reserved for affirming that the applicant has not participated in a college readiness program. Do not use the selection to mean "not indicated" – instead, simply omit the optional
CollegeReadinessProgram
complex type altogether.
Student.ContactInfo
One of only two required entities on the Student entity. Every valid XML data file should have a ContactInfo
entity with an Email
element.
Student.CurrentAddress
The student's current address. This is the place where the student is residing at the time of the application, which may be a dorm, boarding school, or similar. Contrast with Student.PermanentAddress
.
Student.CurrentMajors
The student's current field of study. By convention, applies to current college students only – meaning scholarship programs targeted at graduating high school students will usually not include this information. Contrast with Student.IntendedMajors
.
Student.CurrentEnrollments
Each application may note zero, one, or multiple CurrentEnrollment entities. As the name implies, these are intended to reflect the current status of a student as of the application date, along with an expected graduation date.
Contrast this with the Student.GraduationInfo element which contains information about a graduation that has already happened.
Student.CollegeChoices
The student's college choices. Includes ranking information (to indicate first, second, etc., choices) and the application status (e.g., applied, accepted, declined).
Compare to Student.FinalCollegeChoice
.
Student.CollegeReadinessProgram
The college readiness program or programs in which a student has participated (e.g., AVID, NMSI). Optional.
Used by some scholarship programs as an eligibility requirement.
Student.Disabled
Whether or not the student has a disability.
By convention, implies a formal disability classification per law or regulation such as the Americans with Disabilities Act. In that context, the definition is a person who has a physical or mental impairment that substantially limits one or more major life activity.
Student.DisabilityDesc
A brief description of a student's disability, if the Disabled
element is set to true
.
Student.EducationLevel
Student's highest completed level of school.
Student.Employed
An indicator for whether the student was currently employed at the time the application was filled out. Intended for paid employment (vs. unpaid or volunteer work).
Student.Essays.EssayContent
The Snapp Data Standard supports the exchange of essays. This element contains a student's essay text. It's assumed that some essay modification and customization by the applicant may be necessary.
- The text is limited to 4000 characters. The design intent is to handle a reasonably large maximum length while not requiring receiving systems to handle arbitrarily large essays.
- The essay content should be unformatted, without HTML markup or other text tagging.
- If a sending application allows text longer than the allowable 4000 characters, senders can supply truncated text. Sending applications are encouraged to clip whole words to get the text down to 3996 characters and insert a space followed by a faux ellipsis (i.e., "...") at the end of the essay. This is not required, but provides a visual clue to applicants that there was additional text without assuming anything about the program flow of the receiving system.
See the EssayTypeList documentation for a list of essay prompts supported and a crosswalk/comparison of enumeration values to actual questions.
Student.FinalCollegeChoice
An indicator of the college a student intends to attend. Includes an application status, so implementers can infer a difference between intent and a likely future.
Compare with Student.CollegeChoices
.
Student.Gender
Student Gender refers to the current biological sex of the applicant.
Student.GenderDetail
The Gender Detail for a student provides detail about the biological sex of the applicant. (Contrast with the Orientation List, which provides detail about the applicant's sexual identity.) The list in Snapp was developed from implementer input, UCLA best practices for gender identification in surveys (here), and various government sources.
Student.GovernmentAidParticipation
Information about the program or programs in which a student participates. Optional.
Used by some applications as eligibility criteria.
Student.GPA
A student's grade point average information.
Can be reported for each grade level on a variety of scales (e.g., 4.0, 100, Alphabetic). Averages reported for multiple grades are cumulative. Can indicate weighted or unweighted GPA.
Student.GraduationInfo
The GraduationInfo entity conveys information about an applicant's graduation record. It also conveys information about graduation-equivalent certifications such as the GED program.
Worth noting is that the GraduationInfo is intended to support historical graduation information, that is, a graduation event that has already happened. Contrast this with the Student.CurrentEnrollments entity that notes an applicant's present enrollment status and future-looking expected graduation date.
Student.Income
The student's current income at the time the application was completed. Intended for income earned by the student. Optional.
Information about a parent's income is contained in Student.FAFSA
and Student.Relatives
.
Student.IntendedDiscipline
The student's intended line of work or field of expertise after graduation. Usually relates to a current or intended major, but is not the same thing. For example, a student majoring in French Literature might list "Education" or "Foreign Relations" or some other line of work as their intended discipline.
Student.IntendedMajors
The student's intended areas of study when in school. Contrast with Student.CurrentMajors
.
Student.Name
One of two always-required entities on the Student entity – every valid XML data file should have a Student's first and last name.
Student.Orientation
The student's reported sexual orientation.
Student.Race
The student's race or races.
Student.PermanentAddress
The student's permanent home, often the address of their parent or guardian. Contrast with Student.CurrentAddress
.
Student.ScholarshipPurpose
The type of school for which the student seeks a scholarship (e.g., 2-year program, 4-year program).
Student.SimpleTranscript
A container for structured transcript information. Optional.
As the name implies, it's a fairly basic/simple list of transcript entries identifying a class name, grade level, grade achieved, class properties (e.g., AP, Pre-AP, Honors, IB), class status (e.g., complete, in progress).
Student.SimpleTranscript.ClassNameOtherDesc
The SimpleTranscript contains a ClassName enumeration which has a structured list of class types. The list is fairly general.
Implementers may use the ClassNameOtherDesc element to house a more specific name for a class – even when the type selected by the student is not "Other." There should be no expectation that a receiving system will have a matching algorithm to handle unstructured text, but if the receiving system uses unstructured text to populate its transcript data then it may get value from the ClassNameOtherDesc element.
Student.StudentReferences
The student's references, such as school counselors, registrars, and recommenders. Optional.
Includes basic contact information, length of time the student has known the individual, the type of relationship.
While the type of relationship accounts for a relative/family member, this entity is usually reserved for non-familial references.
Student.TestScores
A student's results on tests such as the PSAT, SAT, ACT and other exams. Allows students to specify a test type, a score, a test date. Contains an "Other" value (e.g., for statewide test results). Optional.
Student.TimeAtCurrentAddress
The length of time the student has lived at their current address (i.e., the Student.CurrentAddress
).
This element uses the fun and seldom-seen xs:duration
type. For example:
- P2Y6M means 2 years, 6 months
- P30M means 30 months (i.e., 2 years, 6 months)
- P3Y means 3 years
By convention, implementers generally use years and months. Note that the xs:duration
type allows days, minutes, seconds.
The xs:duration
also supports time differentials like 30 minutes ago, and other durations that are invalid in the context of Snapp, so implementers should check this carefully when importing information.
Data Standard Documentation Contents
- No labels