Appendix B FOTW API Requirements.docx

APPENDIX B

Data Transfer Requirements

1. Purpose This document includes the current fields and valid field content for the FAFSA On The Web (FOTW) Customer Satisfaction Survey. These fields are transmitted as part of the post Application Programming Interface (API) method, and are transparent to the user. Particular answers to these fields may drive the contractor’s survey application to share with the user specific survey questions or determine the type of survey to be served (e.g., English or Spanish).

2. Interface FOTW submits data to the customer survey contractor using different urls for development, test, and production environments.

The following table specifies the data elements and valid values that FOTW transmits to the contractor.

Note: Application Type values use systemTransaction Data Type to avoid multiple variable names which would include type conversions.

Description

FOTW Field

Parameter Name

Valid Field Values

es = Spanish

For MM:

01-12

For DD:

12 01-31

* unless year is divisible by 4 for non-centurial years or 400 for centurial years when 0129 is valid.

For CC:

For YY:

00-99

I = Independent

2 = Eligible noncitizen 3 = Not a citizen or eligible noncitizen

2 = Married/Remarried 3 = Separated 4 = Divorced or widowed

AL = Alabama AK = Alaska AB = Alberta AS = American Samoa AZ = Arizona AR = Arkansas BC = British Columbia CA = California CN = Canada CO = Colorado CT = Connecticut DE = Delaware DC = District of Columbia FM = Federated States of Micronesia FL = Florida FC = Foreign Country GA = Georgia GU = Guam HI = Hawaii ID = Idaho IL = Illinois IN = Indiana IA = Iowa KS = Kansas KY = Kentucky LA = Louisiana ME = Maine MB = Manitoba MH = Marshall Islands MD = Maryland MA = Massachusetts MX = Mexico MI = Michigan MN = Minnesota MS = Mississippi MO = Missouri MT = Montana NE = Nebraska NV = Nevada NB = New Brunswick NH = New Hampshire NJ = New Jersey NM = New Mexico NY = New York NF = Newfoundland NL = Newfoundland/Labrador NC = North Carolina ND = North Dakota MP = N. Mariana Islands NT = Northwest Territories NS = Nova Scotia NU = Nunavut OH = Ohio OK = Oklahoma ON = Ontario OR = Oregon PW = Palau PA = Pennsylvania PE = Prince Edward Island PR = Puerto Rico PQ = Quebec (PQ) QC = Quebec (QC) RI = Rhode Island SK = Saskatchewan SC = South Carolina SD = South Dakota TN = Tennessee TX = Texas VI = U.S. Virgin Islands UT = Utah VT = Vermont VA = Virginia WA = Washington WV = West Virginia WI = Wisconsin WY = Wyoming YT = Yukon

1 = 1st yr./attended college before 2 = 2nd yr./sophomore 3 = 3rd yr./junior 4 = 4th yr./senior 5 = 5th yr./other undergraduate 6 = 1st yr./graduate/professional 7 = Continuing graduate/professional or beyond

Blank

Expected Family Contribution (EFC)

Blank

B = Spanish Full FAFSA

E = English Easy FAFSA F = Spanish Easy FAFSA

R = English Full Pre-Filled FAFSA T = Spanish Full Pre-Filled FAFSA

G = English Easy Pre-Filled FAFSA H = Spanish Easy Pre-Filled FAFSA