- 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 16 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 Snapp Data Standard XSD supports the inclusion of file attachments in the AttachedFiles entity. Providers can use this construct to include files commonly found in scholarship applications such as a transcript, a portrait of the student, and so forth.
The AttachedFiles entity is optional. The Snapp XSD supports 0-n attachments.
Details
This section contains usage notes and detail about the elements in the AttachedFiles entity:
General Note: File Size
The Snapp XSD specifies no technical limits on the number or size of attachments. This raises an issue for API implementers. If the overall Snapp XML data file can contain multiple files and/or very large files, system designers have to consider issues like resuming dropped connections
The Snapp community, and the Snapp Central API addresses these issues by convention.
- The Snapp Central API does not send attachments by default. Implementers must provide the header value to the Snapp Central API when receiving a file. Implementers may implement the same behavior when sending files to Snapp Central. Snapp Central will be prepared to accept attachments in any exchange, so this is optional.
- Snapp Central limits individual file sizes to 5mb and the overall Snapp XSD file to YY. Implementers that interact with Snapp Central MUST to do the same when sending to Snapp. Implementers SHOULD do the same if they support transfer with other organizations.
General Note: Virus Scanning
Implementers are strongly encouraged to scan files for viruses prior to sending attachments – and upon receipt or first use of files received.
AttachedFile.FileName
Required. The name of the attached file.
Generally includes the file extension (e.g., StudentNamePortrait.png).
AttachedFile.FileNameExtension
Required. The file name extension used to indicate the file type (and type of application used to open the file). For example, PDF for a Portable Data Format document, DOC or DOCX for a Microsoft Word document, and so forth.
- Case-insensitive.
- Omit the leading dot (i.e., DOCX not .DOCX).
AttachedFile.FileDescription
The FileDescription element is defined by the AttachedFileTypeList enumeration. Many of the types are, by design, general in nature, usually where implementers have requested the ability to exchange a type of attachment but where norms aren't established in the application space.
By convention, the following usage is recommended for each type:
| Enumeration Value | Description | Usage Notes |
|---|---|---|
| Audio | Any audio file. | General-purpose type. |
| College Board CSS PROFILE - Data | The College Scholarship Service PROFILE data from College Board. Detailed financial information typically used by private universities to determine an applicant's financial need. | This CSS PROFILE type is used to convey a machine-readable version of the PROFILE. College Board provides this information as XML. Student applicants will typically not upload this file themselves. Programs should only provide this file if they have the rights to do so. |
| College Board CSS PROFILE - Printable | Same as above, only human-readable. | This CSS PROFILE type is used to convey a human-readable version of the PROFILE information. |
| Degree Certificate | A file or image of a degree proving attainment of a degree. | Typically a PDF or image type. |
| Diploma Certificate | A file or image of a certificate of graduation. | Typically a PDF or image type. |
| FAFSA | A file copy of a student's Free Application for Federal Student Aid information. Used by most public institutions and many private institutions to establish financial need. | Typically a PDF. See |
| Formal Student Portrait - Large | A formal portrait of the applicant. Typically:
| Typically an image file type such as JPG, PNG. Can be a GIF, but that doesn't help the complexion. Contrast with |
| Formal Student Portrait - Small | Same as above, only smaller file size. | Typically a small image file type such as JPG, PNG, GIF. Contrast with |
| Informal Picture of Student | A selfie, snapshot, or other informal picture of the student. | Contrast with the two Formal Student Portrait items above. |
| Medical Document | Any medical document. | For all practical purposes, a general-purpose type. (X-rays? Doctors' notes? Admission form?) |
| Picture | Any picture. | General-purpose type. |
| Portfolio Document | An example of an applicant's work. | Can be any human-readable document type. Typically PDF. |
| Proof of Achievement | An award, certificate, affidavit, or other proof of an applicant's achievement. | Can be any human-readable document type. |
| Proof of Employment | A letter from an employer, pay stub, or other proof that the applicant is employed. | Can be any human-readable document type. Typically PDF. |
| Recommendation/Reference Letter | A letter of recommendation or reference on behalf of the applicant. Typically a formal letter from an institution. | Can be any human-readable document type. Typically PDF. |
| School Acceptance Letter | Evidence that an applicant has been accepted into a particular school or program. Typically contains the word "congratulations" somewhere in the text. | Can be any human-readable document type. Typically PDF. |
| Student Aid Report (SAR) | The Student Aid Report summarizes the information an applicant submits on the Free Application for Federal Student Aid (FAFSA) form. | Can be any human-readable document type. Typically PDF. |
| Transcript | The student's academic history. | Can be any human-readable document type. Typically PDF. |
| USDoE MyStudentData File | A downloadable version of the FAFSA information available from the U.S. Department of Education. For information on the MyStudentData program, see this page. | A CSV data file. |
| Video | Any video file. | General-purpose type. |
| Other | A type not found in the above categories (or worthy of additional explanation). | The AttachedFileType.FileOtherDesc element can convey a description of the file. By convention, implementers should always include a FileOtherDesc when Other is selected. |
AttachedFile.FileOtherDescription
Free-form description of the attached file.
By convention, can be used even if the "Other" value in the FileDescription enumeration is not selected.
AttachedFile.File
Required. The attached file data, encoded as MIME base64.
Data Standard Documentation Contents
- No labels