PREVIOUS VERSION

This site is the documentation for a Scholar Snapp Austin (v3.0), a previous version of the Scholar Snapp Technology Suite.

The Snapp solution is currently backward-compatible with v3.0, but all new development projects should leverage Scholar Snapp Technology Suite Berkeley (v4.0).

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 4 Next »

So, you've looked at the use cases and have decided to implement one or more. What's next?

The high-level steps are:

Detail on each follows.

Review the Snapp Profile and the Snapp Data Standard

A student's Snapp Profile contains the data about a student that you can import and export via the Snapp Central API.

The Snapp Profile is simply an XML Data File that adheres to the Snapp Data Standard. The Snapp Data Standard is specified as an XSD.

Data Overview

A student's Snapp Profile contains hundreds of data points. At a high-level, the elements cover:

  • Name
  • Contact & Address Information
  • Birthdate
  • Gender, GenderDetail, Orientation
  • Race, Ethnicity
  • Birthplace, Citizenship
  • Disability Status, Disability Description
  • Armed Services History, Program Eligibility
  • Education Level
  • Test Scores
  • GPA
  • Current Enrollment
  • College Choices, College Application Status
  • Intended Major, Discipline
  • Current Major
  • Application Essays
  • Activities, Hobbies, Volunteering
  • Employment, Income
  • Parent's Finances, FAFSA
  • Marital Status, Dependents
  • Home Environment, Family Situation, Sibling Information
  • Government Aid, Program Participation
  • References, Reference Contact Information
  • Transcript Information

Presuming your application contains any of these data points, your system makes a good candidate for integration with Snapp.

Data Standard Detail

  • The Scholar Snapp XSD is downloadable from this site. The download includes a relatively complete sample Snapp Profile XML document. 
  • The XSD contains type characteristics and annotations. For expanded documentation and real-world usage guidelines, see the Snapp Data Standard Documentation section of this site.



Review the Snapp Central API

The Snapp Central API is the system handles the exchange of Snapp Profiles with your application.

Like most modern APIs, Snapp Central is RESTful, and uses JSON to structure control information. The JSON acts as a "wrapper" for the Snapp Profile XML payload.

Snapp Central API Detail

  • Complete documentation for the API can be found in the Snapp Central API section of this site. 

Map Your Application Form Data to Snapp

If you've ever done a data integration project, you know that it starts with data mapping. Depending on the nature of your application, you may have a few fields that map to a Snapp Profile or you may have, literally, hundreds. A detailed data mapping is the idea starting point.

You or your technology team likely have a mapping template. If you haven't seen one, it's fairly simple – here are a few example rows from a hypothetical mapping:

My App PathMy App FieldMy Data TypeSnapp ElementSnapp Data TypeBusiness Rule PseudocodeNote
Student.Contact.ContactInfoApplicantFirstNameString, Max 50, RequiredStudent.Name.FirstNameString, Max 100, Required

if
snappValue.Length <= 50 then snappValue
else
value.Substring(0, 50);

Snapp allows a longer first name, need to truncate if longer than our max of 50 characters.
Student.Contact.ContactInfoApplicantMiddleInitialString, Max 1, OptionalStudent.Name.MiddleNameString, Max 100, Optionalif != null
value.Substring(1);		Snapp allows an optional, 100 character full middle name, we just hold initials. Need to check whether the Snapp Profile has the data and just grab the initial if present.







Developer Toolkit Contents

  • No labels