Versions Compared

Version Old Version 6 New Version 7
Changes made by

Ian Christopher (Deactivated)

Ian Christopher (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  • Overview

The Context entity contains metadata about the file. It contains three required elements (Created, CreatedBy, and ApplicationLanguage) and thus should be present in every valid Snapp XML data file.

Details

This section contains detail and usage notes about the elements in the Context entity:

Table of Contents
maxLevel2
minLevel2
exclude.*Contents.*

Created

Required. The date that the Snapp Data Standard file was created. 

Example Value: 

  • 2018-03-12T20:20:10.001Z

Usage Notes:

  • Should be treated as read-only once provided.

CreatedBy

Required. The organization or website that originally created the application. 

Example Value: 

Usage Notes:

  • Should be treated as read-only once provided.
  • Application data files which originate in the Snapp Application use "ScholarSnapp.org" in the CreatedBy entity.

We ask that implementers use the following guidelines:

  • Do pick a human-readable name or URL. As of Snapp v4.0, the Snapp program does not maintain a registry of organizations or file creators, so implementers may select their own. We recommend a human-readable name such as "Dell Scholars Program" or "Common App" or similar. It's also okay to use a domain name.
  • Aggregator systems that exchange data related to multiple scholarship program applications may specify either individual program names, the host name, or a combination of both.
  • Do use the same CreatedBy name for the duration of an application cycle.

LastUpdated

The date that the Snapp Data Standard file was last modified.

Example Value:  

  • 2018-03-12 T22:20:10.001Z

Usage Notes:

  • The Snapp Central API will only update this value if the data was altered in the Snapp context – whether by an automated process or via the online Snapp Application form. If the data is passed directly from one application to another, we will not modify this value.

LastUpdatedBy

The organization or website that last saved the data file.

Example Value:  

Usage Notes:

  • Similar to LastUpdated, the Snapp Central API will only update this value if the data was altered in the Snapp context – whether by an automated process or via the online Snapp Application form. If the data is passed directly from one application to another, we will not modify this value.

ApplicationLanguage

Required. The language in which the Snapp Data Standard file was created. Uses a culture code enumeration, so we usually see en-US.


Include Page
_Sidebar - Data Standard
_Sidebar - Data Standard