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 2 Current »

This page contains a specification for the NSPA Scholarship Program Information Data Exchange for Flat-File specification.

Notes & Implementation Guidelines

Simple & Extended Representations

  • Specifications are provided for a Simple Flat-File and an Extended Flat-File.

    • The Simple Flat-File is suitable for review and editing by humans. The fields present are those with common-language definitions and the data entry options are simple.

    • The Extended Flat-File is suitable for expert human data entry and machine-to-machine transfer. Some fields can contain multiple values, other fields have constraints or require reference to external value lists, and so forth.

  • The specification table below shows which fields are part of the Simple vs. Extended specifications.

  • Both specifications are currently v1.0.

General Notes

  • Only two fields are required: the Program Name and Organization Name.

  • A transformation from the flat-file to the NSPA Data Standard loses no information. However, similar to many flat-file representations of complex data models, a transformation from the complex NSPA Data Standard (say, an XML or JSON data file) may lose information. This is because not all fields are present in the Flat-File specification, and many repeating elements in the XML or JSON are not easily mapped to a workable flat-file format.

Spec & Schema Mapping

The specification below shows whether an element is included in the Simple or Extended Flat-File, as well as a mapping to the appropriate element in the NSPA Scholarship Program Data Standard.

Column Name

Element Mapping

Part of
Simple?

Part of Extended?

Required?

General Type

Text Length

Program Reference ID

ProgramReferenceID

Yes

Yes

Text

256

Program Name

ProgramName

Yes

Yes

Yes

Text

100

Organization Name

ProgramOrganization.OrganizationName

Yes

Yes

Yes

Text

100

Program Self-Description

ProgramSelfDescription

Yes

Yes

Multi-Line Text

4000

Award Amount

ScholarshipMaximumAward

Yes

Yes

Integer

Minimum Award

ScholarshipMinimumAward

Yes

Yes

Integer

Number of Awards

NumberOfScholarshipsAwarded

Yes

Yes

Integer

Minimum GPA

EligibilityCriteria.Academics.AcademicEligibility

Yes

Yes

Decimal

Maximum GPA

EligibilityCriteria.Academics.AcademicEligibility

Yes

Decimal

Open Date

OpenDate

Yes

Yes

Date

Close Date

CloseDate

Yes

Yes

Date

Award Announcement Date

AnnouncementDate

Yes

Yes

Date

Program URL

ProgramURL

Yes

Yes

Text

512

Application URL

ApplicationURL

Yes

Yes

Text

512

Application Type

Metadata-Only

Yes

Yes

Option List

256

Is Need-Based

IsNeedBased

Yes

Yes

Option List

24

Is Merit-Based

IsMeritBased

Yes

Yes

Option List

24

Is Contest

IsContest

Yes

Yes

Option List

24

Minimum Overall SAT

EligibilityCriteria.Academics.AcademicEligibility

Yes

Yes

Integer

Minimum SAT Math

EligibilityCriteria.Academics.AcademicEligibility

Yes

Yes

Integer

Minimum SAT Evidence-Based Reading and Writing

EligibilityCriteria.Academics.AcademicEligibility

Yes

Yes

Integer

Minimum Class Rank Percentage

EligibilityCriteria.Academics.AcademicEligibility

Yes

Yes

Decimal

Minimum ACT Composite

EligibilityCriteria.Academics.AcademicEligibility

Yes

Yes

Integer

Maximum Class Rank Percentage

EligibilityCriteria.Academics.AcademicEligibility

Yes

Decimal

Activity

EligibilityCriteria.Activity

Yes

Option List + Free Text

512

Citizenship Status

EligibilityCriteria.CitizenshipStatuses

Yes

Option List

512

Current Grade Level

EligibilityCriteria.CurrentGradeLevel

Yes

Option List

512

College Type

EligibilityCriteria.CollegePlans.CollegeType

Yes

Option List

512

College Category

EligibilityCriteria.CollegePlans.CollegeCategory

Yes

Option List

512

Current School NCES Codes

EligibilityCriteria.CurrentSchool.School.NCESCode

Yes

Text

512

Current School CEEB Codes

EligibilityCriteria.CurrentSchool.School.CEEBCode

Yes

Text

512

College Attendance NCES Codes

EligibilityCriteria.CollegePlan.College.NCESCode

Yes

Text

512

College Attendance CEEB Codes

EligibilityCriteria.CollegePlan.College.CEEBCode

Yes

Text

512

Graduation Status NCES Codes

EligibilityCriteria.Graduation.AlmaMater.NCESCode

Yes

Text

512

Graduation Status CEEB Codes

EligibilityCriteria.Graduation.AlmaMater.CEEBCode

Yes

Text

512

Degree Seeking

EligibilityCriteria.DegreeSeeking

Yes

Option List

512

Full-Time Student

EligibilityCriteria.EnrollmentStatus

Yes

Yes

Text

24

Gender

EligibilityCriteria.Demographics

Yes

Option List

512

Race

EligibilityCriteria.Demographics

Yes

Option List

512

LGBTQ+

EligibilityCriteria.Demographics

Yes

Option List + Free Text

512

Minimum Age

EligibilityCriteria.Age.MinimumAgeRequirement

Yes

Integer

Maximum Age

EligibilityCriteria.Age.MaximumAgeRequirement

Yes

Integer

Maximum AGI

EligibilityCriteria.FinancialInformation.FinancialEligibility.Amount

Yes

Yes

Integer

Maximum EFC

EligibilityCriteria.FinancialInformation.FinancialEligibility.Amount

Yes

Yes

Integer

City

EligibilityCriteria.Locations.Location.City

Yes

Text

512

County

EligibilityCriteria.Locations.Location.County

Yes

Text

512

State

EligibilityCriteria.Locations.Location.State

Yes

Text (From Option List)

512

Country

EligibilityCriteria.Locations.Location.Country

Yes

Text

Award Duration Type

AwardDuration.AwardDurationType

Yes

Option List

512

Duration Years

AwardDuration.DurationYears

Yes

Integer

Application Restriction

EligibilityCriteria.ApplicationRestriction.ApplicationRestriction

Yes

Option List

512

Listing Flags

NoteworthyApplicationCharacteristics.ListingFlags.ListingFlag

Yes

Option List

512

  • No labels