As of October 1, 2020, Scholar Snapp Central API functionality is hosted by the College Board. See the College Board Website for details.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Current »

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 a header value to the Snapp Central API when requesting that a Snapp Profile include files. 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 2mb and the overall Snapp XSD file to 5mb. Implementers that interact with Snapp Central MUST to do the same when sending to Snapp, unless specific arrangements have been made. 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. 

Example Value: 

  • Small-Text-File
  • McTestface-FAFSA-2018

Usage Notes:

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.

Example Values: 

  • TXT
  • PDF
  • DOCX

Usage Notes:

  • 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.

Example Values:

  • Student Aid Report (SAR)
  • School Acceptance Letter

Usage Notes:

AttachedFile.FileOtherDescription

Free-form description of the attached file.

Example Values:

  • A wee little test file
  • Deep Thoughts of a Scholar

Usage Notes:

  • 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.

Example Value: 

  • SWYgeW91IGNhbiByZWFkIHRoaXMsIHlvdSBtdXN0IGJlIGJvcmVkIG91dCBvZiB5b3VyIGdvdXJkLg==

Contents

  • No labels