# Field
As different scholarship may require different information from student, we want our scholarship to be agile and configurable in different ways, so to accept different kinds of data from a student's profile.
Each profile’s data chunk ( name, email, phone, etc. ) is called a field. Scholarship may have many configured fields. Each field must be included in application's data when students applies for the scholarship.
Fields must be configurable in a scholarship provider’s interface when he/she creates a new scholarship.
# Attributes
id- String - Unique identifier of the field.
name- String - Field name.
type- String - Field type.
options- null|JSON Object - If type is option so
optionswill be JSON Object, with list of available options. Key is the "id" that should be sent as selected value. Item in the list can be 2 types: String or JSON Object. If an option value type isstringwe can use it as option label, another way if it isobjectwe MUST havenameproperty that can be used as option label.
- null|JSON Object - If type is option so
# String example
{
"1": "High school freshman",
"2": "High school sophomore",
"3": "High school junior",
"4": "High school senior",
"5": "College 1st year",
"6": "College 2nd year",
"7": "College 3rd year",
"8": "College 4th year",
"9": "Graduate student",
"10": "Adult/Non-traditional Student"
}
# JSON Object example
{
"1": {
"name": "Alabama",
"abbreviation": "AL"
},
"2": {
"name": "Alaska",
"abbreviation": "AK"
},
"3": {
"name": "Arizona",
"abbreviation": "AZ"
},
...,
"52": {
"name": "Wyoming",
"abbreviation": "WY"
}
}
# Actions
- Get all fields details
/api/field - Get field details by id
/api/field/@id
# Default Fields
Each application requires a name, email and phone number in order to apply; the other fields are optional.
| Id | Name | Type | Description | Available eligibilities |
|---|---|---|---|---|
| name | Name | text | To apply to the scholarship each student need to provide his full name. | None |
| Student's private e-mail. We contact the student by sending emails ( winner notification ) to his email. | None | |||
| phone | Phone | phone | Student's phone can be also used for contacting the student in case of winning. | None |
# Fields list
List of available fields, depending on type and available options.
| Id | Type | Name | Description | Available eligibilities |
|---|---|---|---|---|
| dateOfBirth | date | Date Of Birth | Student's date of birth | eq, neq, gt, gte, lt, lte ( Applied to student's age) |
| city | text | City | Student's city of living | |
| address | text | Address | Student's address | |
| zip | text | Zip | Student's zip code | |
| country | option | Country | Student's country | eq, neq, in, nin |
| state | option | State | Student's USA state where he lives. | eq, neq, in, nin |
| schoolLevel | option | School level | Student's school level allowed to apply to the scholarship. | eq, neq, in, nin |
| fieldOfStudy | option | Field Of Study | Student's field of study ( degree ). | eq, neq, in, nin |
| degreeType | option | Degree type | Student's degree type. | eq, neq, in, nin |
| GPA | option | GPA | Student's GPA. | eq, neq, in, nin |
| gender | option | Gender | Student's gender. | eq, neq, in, nin |
| ethnicity | option | Ethnicity | Student's Ethnicity. | eq, neq, in, nin |
| careerGoal | option | Career goal | Career goal. | eq, neq, in, nin |
| enrolledInCollege | option | Enrolled in College | Is student enrolled in college | eq |
| enrollmentDate | date | Enrollment date | Date of enrollment to college. | eq, neq, gt, gte, lt, lte |
| highSchoolName | text | High school name | Student's high school name. | |
| highSchoolGraduationDate | date | High school graduation date | Student's high school graduation date. | eq, neq, gt, gte, lt, lte |
| collegeName | text | College name | Student's college name. | |
| collegeGraduationDate | date | College graduation date | Student's college graduation date. | eq, neq, gt, gte, lt, lte |
| militaryAffiliation | option | Military Affiliation | Military affiliation | eq, neq, in, nin |
| citizenship | option | Citizenship | USA citizenship status | eq, neq, in, nin |
# Country
# Get country field details
GET /api/field/country
{
"data": {
"type": "field",
"id": "country",
"attributes": {
"name": "Country",
"type": "option",
"options": {
"1": {
"name": "USA",
"abbreviation": "US"
},
"2": {
"name": "Afghanistan",
"abbreviation": "AF"
},
"3": {
"name": "Åland Islands",
"abbreviation": "AX"
},
"4": {
"name": "Albania",
"abbreviation": "AL"
},
"5": {
"name": "Algeria",
"abbreviation": "DZ"
},
"6": {
"name": "American Samoa",
"abbreviation": "AS"
},
"7": {
"name": "Andorra",
"abbreviation": "AD"
},
"8": {
"name": "Angola",
"abbreviation": "AO"
},
"9": {
"name": "Anguilla",
"abbreviation": "AI"
},
"10": {
"name": "Antarctica",
"abbreviation": "AQ"
},
"11": {
"name": "Antigua and Barbuda",
"abbreviation": "AG"
},
"12": {
"name": "Argentina",
"abbreviation": "AR"
},
"13": {
"name": "Armenia",
"abbreviation": "AM"
},
"14": {
"name": "Aruba",
"abbreviation": "AW"
},
"15": {
"name": "Australia",
"abbreviation": "AU"
},
"16": {
"name": "Austria",
"abbreviation": "AT"
},
"17": {
"name": "Azerbaijan",
"abbreviation": "AZ"
},
"18": {
"name": "Bahamas",
"abbreviation": "BS"
},
"19": {
"name": "Bahrain",
"abbreviation": "BH"
},
"20": {
"name": "Bangladesh",
"abbreviation": "BD"
},
"21": {
"name": "Barbados",
"abbreviation": "BB"
},
"22": {
"name": "Belarus",
"abbreviation": "BY"
},
"23": {
"name": "Belgium",
"abbreviation": "BE"
},
"24": {
"name": "Belize",
"abbreviation": "BZ"
},
"25": {
"name": "Benin",
"abbreviation": "BJ"
},
"26": {
"name": "Bermuda",
"abbreviation": "BM"
},
"27": {
"name": "Bhutan",
"abbreviation": "BT"
},
"28": {
"name": "Bolivia, Plurinational State of",
"abbreviation": "BO"
},
"29": {
"name": "Bonaire, Sint Eustatius and Saba",
"abbreviation": "BQ"
},
"30": {
"name": "Bosnia and Herzegovina",
"abbreviation": "BA"
},
"31": {
"name": "Botswana",
"abbreviation": "BW"
},
"32": {
"name": "Bouvet Island",
"abbreviation": "BV"
},
"33": {
"name": "Brazil",
"abbreviation": "BR"
},
"34": {
"name": "British Indian Ocean Territory",
"abbreviation": "IO"
},
"35": {
"name": "Brunei Darussalam",
"abbreviation": "BN"
},
"36": {
"name": "Bulgaria",
"abbreviation": "BG"
},
"37": {
"name": "Burkina Faso",
"abbreviation": "BF"
},
"38": {
"name": "Burundi",
"abbreviation": "BI"
},
"39": {
"name": "Cambodia",
"abbreviation": "KH"
},
"40": {
"name": "Cameroon",
"abbreviation": "CM"
},
"41": {
"name": "Canada",
"abbreviation": "CA"
},
"42": {
"name": "Cape Verde",
"abbreviation": "CV"
},
"43": {
"name": "Cayman Islands",
"abbreviation": "KY"
},
"44": {
"name": "Central African Republic",
"abbreviation": "CF"
},
"45": {
"name": "Chad",
"abbreviation": "TD"
},
"46": {
"name": "Chile",
"abbreviation": "CL"
},
"47": {
"name": "China",
"abbreviation": "CN"
},
"48": {
"name": "Christmas Island",
"abbreviation": "CX"
},
"49": {
"name": "Cocos (Keeling) Islands",
"abbreviation": "CC"
},
"50": {
"name": "Colombia",
"abbreviation": "CO"
},
"51": {
"name": "Comoros",
"abbreviation": "KM"
},
"52": {
"name": "Congo",
"abbreviation": "CG"
},
"53": {
"name": "Congo, the Democratic Republic of the",
"abbreviation": "CD"
},
"54": {
"name": "Cook Islands",
"abbreviation": "CK"
},
"55": {
"name": "Costa Rica",
"abbreviation": "CR"
},
"56": {
"name": "Côte d'Ivoire",
"abbreviation": "CI"
},
"57": {
"name": "Croatia",
"abbreviation": "HR"
},
"58": {
"name": "Cuba",
"abbreviation": "CU"
},
"59": {
"name": "Curaçao",
"abbreviation": "CW"
},
"60": {
"name": "Cyprus",
"abbreviation": "CY"
},
"61": {
"name": "Czech Republic",
"abbreviation": "CZ"
},
"62": {
"name": "Denmark",
"abbreviation": "DK"
},
"63": {
"name": "Djibouti",
"abbreviation": "DJ"
},
"64": {
"name": "Dominica",
"abbreviation": "DM"
},
"65": {
"name": "Dominican Republic",
"abbreviation": "DO"
},
"66": {
"name": "Ecuador",
"abbreviation": "EC"
},
"67": {
"name": "Egypt",
"abbreviation": "EG"
},
"68": {
"name": "El Salvador",
"abbreviation": "SV"
},
"69": {
"name": "Equatorial Guinea",
"abbreviation": "GQ"
},
"70": {
"name": "Eritrea",
"abbreviation": "ER"
},
"71": {
"name": "Estonia",
"abbreviation": "EE"
},
"72": {
"name": "Ethiopia",
"abbreviation": "ET"
},
"73": {
"name": "Falkland Islands (Malvinas)",
"abbreviation": "FK"
},
"74": {
"name": "Faroe Islands",
"abbreviation": "FO"
},
"75": {
"name": "Fiji",
"abbreviation": "FJ"
},
"76": {
"name": "Finland",
"abbreviation": "FI"
},
"77": {
"name": "France",
"abbreviation": "FR"
},
"78": {
"name": "French Guiana",
"abbreviation": "GF"
},
"79": {
"name": "French Polynesia",
"abbreviation": "PF"
},
"80": {
"name": "French Southern Territories",
"abbreviation": "TF"
},
"81": {
"name": "Gabon",
"abbreviation": "GA"
},
"82": {
"name": "Gambia",
"abbreviation": "GM"
},
"83": {
"name": "Georgia",
"abbreviation": "GE"
},
"84": {
"name": "Germany",
"abbreviation": "DE"
},
"85": {
"name": "Ghana",
"abbreviation": "GH"
},
"86": {
"name": "Gibraltar",
"abbreviation": "GI"
},
"87": {
"name": "Greece",
"abbreviation": "GR"
},
"88": {
"name": "Greenland",
"abbreviation": "GL"
},
"89": {
"name": "Grenada",
"abbreviation": "GD"
},
"90": {
"name": "Guadeloupe",
"abbreviation": "GP"
},
"91": {
"name": "Guam",
"abbreviation": "GU"
},
"92": {
"name": "Guatemala",
"abbreviation": "GT"
},
"93": {
"name": "Guernsey",
"abbreviation": "GG"
},
"94": {
"name": "Guinea",
"abbreviation": "GN"
},
"95": {
"name": "Guinea-Bissau",
"abbreviation": "GW"
},
"96": {
"name": "Guyana",
"abbreviation": "GY"
},
"97": {
"name": "Haiti",
"abbreviation": "HT"
},
"98": {
"name": "Heard Island and McDonald Islands",
"abbreviation": "HM"
},
"99": {
"name": "Holy See (Vatican City State)",
"abbreviation": "VA"
},
"100": {
"name": "Honduras",
"abbreviation": "HN"
},
"101": {
"name": "Hong Kong",
"abbreviation": "HK"
},
"102": {
"name": "Hungary",
"abbreviation": "HU"
},
"103": {
"name": "Iceland",
"abbreviation": "IS"
},
"104": {
"name": "India",
"abbreviation": "IN"
},
"105": {
"name": "Indonesia",
"abbreviation": "ID"
},
"106": {
"name": "Iran, Islamic Republic of",
"abbreviation": "IR"
},
"107": {
"name": "Iraq",
"abbreviation": "IQ"
},
"108": {
"name": "Ireland",
"abbreviation": "IE"
},
"109": {
"name": "Isle of Man",
"abbreviation": "IM"
},
"110": {
"name": "Israel",
"abbreviation": "IL"
},
"111": {
"name": "Italy",
"abbreviation": "IT"
},
"112": {
"name": "Jamaica",
"abbreviation": "JM"
},
"113": {
"name": "Japan",
"abbreviation": "JP"
},
"114": {
"name": "Jersey",
"abbreviation": "JE"
},
"115": {
"name": "Jordan",
"abbreviation": "JO"
},
"116": {
"name": "Kazakhstan",
"abbreviation": "KZ"
},
"117": {
"name": "Kenya",
"abbreviation": "KE"
},
"118": {
"name": "Kiribati",
"abbreviation": "KI"
},
"119": {
"name": "Korea, Democratic People's Republic of",
"abbreviation": "KP"
},
"120": {
"name": "Korea, Republic of",
"abbreviation": "KR"
},
"121": {
"name": "Kuwait",
"abbreviation": "KW"
},
"122": {
"name": "Kyrgyzstan",
"abbreviation": "KG"
},
"123": {
"name": "Lao People's Democratic Republic",
"abbreviation": "LA"
},
"124": {
"name": "Latvia",
"abbreviation": "LV"
},
"125": {
"name": "Lebanon",
"abbreviation": "LB"
},
"126": {
"name": "Lesotho",
"abbreviation": "LS"
},
"127": {
"name": "Liberia",
"abbreviation": "LR"
},
"128": {
"name": "Libya",
"abbreviation": "LY"
},
"129": {
"name": "Liechtenstein",
"abbreviation": "LI"
},
"130": {
"name": "Lithuania",
"abbreviation": "LT"
},
"131": {
"name": "Luxembourg",
"abbreviation": "LU"
},
"132": {
"name": "Macao",
"abbreviation": "MO"
},
"133": {
"name": "Macedonia, the Former Yugoslav Republic of",
"abbreviation": "MK"
},
"134": {
"name": "Madagascar",
"abbreviation": "MG"
},
"135": {
"name": "Malawi",
"abbreviation": "MW"
},
"136": {
"name": "Malaysia",
"abbreviation": "MY"
},
"137": {
"name": "Maldives",
"abbreviation": "MV"
},
"138": {
"name": "Mali",
"abbreviation": "ML"
},
"139": {
"name": "Malta",
"abbreviation": "MT"
},
"140": {
"name": "Marshall Islands",
"abbreviation": "MH"
},
"141": {
"name": "Martinique",
"abbreviation": "MQ"
},
"142": {
"name": "Mauritania",
"abbreviation": "MR"
},
"143": {
"name": "Mauritius",
"abbreviation": "MU"
},
"144": {
"name": "Mayotte",
"abbreviation": "YT"
},
"145": {
"name": "Mexico",
"abbreviation": "MX"
},
"146": {
"name": "Micronesia, Federated States of",
"abbreviation": "FM"
},
"147": {
"name": "Moldova, Republic of",
"abbreviation": "MD"
},
"148": {
"name": "Monaco",
"abbreviation": "MC"
},
"149": {
"name": "Mongolia",
"abbreviation": "MN"
},
"150": {
"name": "Montenegro",
"abbreviation": "ME"
},
"151": {
"name": "Montserrat",
"abbreviation": "MS"
},
"152": {
"name": "Morocco",
"abbreviation": "MA"
},
"153": {
"name": "Mozambique",
"abbreviation": "MZ"
},
"154": {
"name": "Myanmar",
"abbreviation": "MM"
},
"155": {
"name": "Namibia",
"abbreviation": "NA"
},
"156": {
"name": "Nauru",
"abbreviation": "NR"
},
"157": {
"name": "Nepal",
"abbreviation": "NP"
},
"158": {
"name": "Netherlands",
"abbreviation": "NL"
},
"159": {
"name": "New Caledonia",
"abbreviation": "NC"
},
"160": {
"name": "New Zealand",
"abbreviation": "NZ"
},
"161": {
"name": "Nicaragua",
"abbreviation": "NI"
},
"162": {
"name": "Niger",
"abbreviation": "NE"
},
"163": {
"name": "Nigeria",
"abbreviation": "NG"
},
"164": {
"name": "Niue",
"abbreviation": "NU"
},
"165": {
"name": "Norfolk Island",
"abbreviation": "NF"
},
"166": {
"name": "Northern Mariana Islands",
"abbreviation": "MP"
},
"167": {
"name": "Norway",
"abbreviation": "NO"
},
"168": {
"name": "Oman",
"abbreviation": "OM"
},
"169": {
"name": "Pakistan",
"abbreviation": "PK"
},
"170": {
"name": "Palau",
"abbreviation": "PW"
},
"171": {
"name": "Palestine, State of",
"abbreviation": "PS"
},
"172": {
"name": "Panama",
"abbreviation": "PA"
},
"173": {
"name": "Papua New Guinea",
"abbreviation": "PG"
},
"174": {
"name": "Paraguay",
"abbreviation": "PY"
},
"175": {
"name": "Peru",
"abbreviation": "PE"
},
"176": {
"name": "Philippines",
"abbreviation": "PH"
},
"177": {
"name": "Pitcairn",
"abbreviation": "PN"
},
"178": {
"name": "Poland",
"abbreviation": "PL"
},
"179": {
"name": "Portugal",
"abbreviation": "PT"
},
"180": {
"name": "Puerto Rico",
"abbreviation": "PR"
},
"181": {
"name": "Qatar",
"abbreviation": "QA"
},
"182": {
"name": "Réunion",
"abbreviation": "RE"
},
"183": {
"name": "Romania",
"abbreviation": "RO"
},
"184": {
"name": "Russian Federation",
"abbreviation": "RU"
},
"185": {
"name": "Rwanda",
"abbreviation": "RW"
},
"186": {
"name": "Saint Barthélemy",
"abbreviation": "BL"
},
"187": {
"name": "Saint Helena, Ascension and Tristan da Cunha",
"abbreviation": "SH"
},
"188": {
"name": "Saint Kitts and Nevis",
"abbreviation": "KN"
},
"189": {
"name": "Saint Lucia",
"abbreviation": "LC"
},
"190": {
"name": "Saint Martin (French part)",
"abbreviation": "MF"
},
"191": {
"name": "Saint Pierre and Miquelon",
"abbreviation": "PM"
},
"192": {
"name": "Saint Vincent and the Grenadines",
"abbreviation": "VC"
},
"193": {
"name": "Samoa",
"abbreviation": "WS"
},
"194": {
"name": "San Marino",
"abbreviation": "SM"
},
"195": {
"name": "Sao Tome and Principe",
"abbreviation": "ST"
},
"196": {
"name": "Saudi Arabia",
"abbreviation": "SA"
},
"197": {
"name": "Senegal",
"abbreviation": "SN"
},
"198": {
"name": "Serbia",
"abbreviation": "RS"
},
"199": {
"name": "Seychelles",
"abbreviation": "SC"
},
"200": {
"name": "Sierra Leone",
"abbreviation": "SL"
},
"201": {
"name": "Singapore",
"abbreviation": "SG"
},
"202": {
"name": "Sint Maarten (Dutch part)",
"abbreviation": "SX"
},
"203": {
"name": "Slovakia",
"abbreviation": "SK"
},
"204": {
"name": "Slovenia",
"abbreviation": "SI"
},
"205": {
"name": "Solomon Islands",
"abbreviation": "SB"
},
"206": {
"name": "Somalia",
"abbreviation": "SO"
},
"207": {
"name": "South Africa",
"abbreviation": "ZA"
},
"208": {
"name": "South Georgia and the South Sandwich Islands",
"abbreviation": "GS"
},
"209": {
"name": "South Sudan",
"abbreviation": "SS"
},
"210": {
"name": "Spain",
"abbreviation": "ES"
},
"211": {
"name": "Sri Lanka",
"abbreviation": "LK"
},
"212": {
"name": "Sudan",
"abbreviation": "SD"
},
"213": {
"name": "Suriname",
"abbreviation": "SR"
},
"214": {
"name": "Svalbard and Jan Mayen",
"abbreviation": "SJ"
},
"215": {
"name": "Swaziland",
"abbreviation": "SZ"
},
"216": {
"name": "Sweden",
"abbreviation": "SE"
},
"217": {
"name": "Switzerland",
"abbreviation": "CH"
},
"218": {
"name": "Syrian Arab Republic",
"abbreviation": "SY"
},
"219": {
"name": "Taiwan, Province of China",
"abbreviation": "TW"
},
"220": {
"name": "Tajikistan",
"abbreviation": "TJ"
},
"221": {
"name": "Tanzania, United Republic of",
"abbreviation": "TZ"
},
"222": {
"name": "Thailand",
"abbreviation": "TH"
},
"223": {
"name": "Timor-Leste",
"abbreviation": "TL"
},
"224": {
"name": "Togo",
"abbreviation": "TG"
},
"225": {
"name": "Tokelau",
"abbreviation": "TK"
},
"226": {
"name": "Tonga",
"abbreviation": "TO"
},
"227": {
"name": "Trinidad and Tobago",
"abbreviation": "TT"
},
"228": {
"name": "Tunisia",
"abbreviation": "TN"
},
"229": {
"name": "Turkey",
"abbreviation": "TR"
},
"230": {
"name": "Turkmenistan",
"abbreviation": "TM"
},
"231": {
"name": "Turks and Caicos Islands",
"abbreviation": "TC"
},
"232": {
"name": "Tuvalu",
"abbreviation": "TV"
},
"233": {
"name": "Uganda",
"abbreviation": "UG"
},
"234": {
"name": "Ukraine",
"abbreviation": "UA"
},
"235": {
"name": "United Arab Emirates",
"abbreviation": "AE"
},
"236": {
"name": "United Kingdom",
"abbreviation": "GB"
},
"237": {
"name": "United States Minor Outlying Islands",
"abbreviation": "UM"
},
"238": {
"name": "Uruguay",
"abbreviation": "UY"
},
"239": {
"name": "Uzbekistan",
"abbreviation": "UZ"
},
"240": {
"name": "Vanuatu",
"abbreviation": "VU"
},
"241": {
"name": "Venezuela, Bolivarian Republic of",
"abbreviation": "VE"
},
"242": {
"name": "Viet Nam",
"abbreviation": "VN"
},
"243": {
"name": "Virgin Islands, British",
"abbreviation": "VG"
},
"244": {
"name": "Virgin Islands, U.S.",
"abbreviation": "VI"
},
"245": {
"name": "Wallis and Futuna",
"abbreviation": "WF"
},
"246": {
"name": "Western Sahara",
"abbreviation": "EH"
},
"247": {
"name": "Yemen",
"abbreviation": "YE"
},
"248": {
"name": "Zambia",
"abbreviation": "ZM"
},
"249": {
"name": "Zimbabwe",
"abbreviation": "ZW"
}
}
},
"links": {
"self": "/field/country"
}
}
}
# State
# Get list field details.
GET /api/field/state
{
"data": {
"type": "field",
"id": "state",
"attributes": {
"name": "State",
"type": "option",
"options": {
"1": {
"name": "Alabama",
"abbreviation": "AL"
},
"2": {
"name": "Alaska",
"abbreviation": "AK"
},
"3": {
"name": "Arizona",
"abbreviation": "AZ"
},
"4": {
"name": "Arkansas",
"abbreviation": "AR"
},
"5": {
"name": "California",
"abbreviation": "CA"
},
"6": {
"name": "Colorado",
"abbreviation": "CO"
},
"7": {
"name": "Connecticut",
"abbreviation": "CT"
},
"8": {
"name": "Delaware",
"abbreviation": "DE"
},
"9": {
"name": "District of Columbia",
"abbreviation": "DC"
},
"10": {
"name": "Florida",
"abbreviation": "FL"
},
"11": {
"name": "Georgia",
"abbreviation": "GA"
},
"12": {
"name": "Hawaii",
"abbreviation": "HI"
},
"13": {
"name": "Idaho",
"abbreviation": "ID"
},
"14": {
"name": "Illinois",
"abbreviation": "IL"
},
"15": {
"name": "Indiana",
"abbreviation": "IN"
},
"16": {
"name": "Iowa",
"abbreviation": "IA"
},
"17": {
"name": "Kansas",
"abbreviation": "KS"
},
"18": {
"name": "Kentucky",
"abbreviation": "KY"
},
"19": {
"name": "Louisiana",
"abbreviation": "LA"
},
"20": {
"name": "Maine",
"abbreviation": "ME"
},
"21": {
"name": "Maryland",
"abbreviation": "MD"
},
"22": {
"name": "Massachusetts",
"abbreviation": "MA"
},
"23": {
"name": "Michigan",
"abbreviation": "MI"
},
"24": {
"name": "Minnesota",
"abbreviation": "MN"
},
"25": {
"name": "Mississippi",
"abbreviation": "MS"
},
"26": {
"name": "Missouri",
"abbreviation": "MO"
},
"27": {
"name": "Montana",
"abbreviation": "MT"
},
"28": {
"name": "Nebraska",
"abbreviation": "NE"
},
"29": {
"name": "Nevada",
"abbreviation": "NV"
},
"30": {
"name": "New Hampshire",
"abbreviation": "NH"
},
"31": {
"name": "New Jersey",
"abbreviation": "NJ"
},
"32": {
"name": "New Mexico",
"abbreviation": "NM"
},
"33": {
"name": "New York",
"abbreviation": "NY"
},
"34": {
"name": "North Carolina",
"abbreviation": "NC"
},
"35": {
"name": "North Dakota",
"abbreviation": "ND"
},
"36": {
"name": "Ohio",
"abbreviation": "OH"
},
"37": {
"name": "Oklahoma",
"abbreviation": "OK"
},
"38": {
"name": "Oregon",
"abbreviation": "OR"
},
"39": {
"name": "Pennsylvania",
"abbreviation": "PA"
},
"40": {
"name": "Puerto Rico",
"abbreviation": "PR"
},
"41": {
"name": "Rhode Island",
"abbreviation": "RI"
},
"42": {
"name": "South Carolina",
"abbreviation": "SC"
},
"43": {
"name": "South Dakota",
"abbreviation": "SD"
},
"44": {
"name": "Tennessee",
"abbreviation": "TN"
},
"45": {
"name": "Texas",
"abbreviation": "TX"
},
"46": {
"name": "Utah",
"abbreviation": "UT"
},
"47": {
"name": "Vermont",
"abbreviation": "VT"
},
"48": {
"name": "Virginia",
"abbreviation": "VA"
},
"49": {
"name": "Washington",
"abbreviation": "WA"
},
"50": {
"name": "West Virginia",
"abbreviation": "WV"
},
"51": {
"name": "Wisconsin",
"abbreviation": "WI"
},
"52": {
"name": "Wyoming",
"abbreviation": "WY"
}
}
},
"links": {
"self": "/field/state"
}
}
}
# School level
# Get list field details.
GET /api/field/schoolLevel
{
"data": {
"type": "field",
"id": "schoolLevel",
"attributes": {
"name": "School Level",
"type": "option",
"options": {
"1": "High school freshman",
"2": "High school sophomore",
"3": "High school junior",
"4": "High school senior",
"5": "College 1st year",
"6": "College 2nd year",
"7": "College 3rd year",
"8": "College 4th year",
"9": "Graduate student",
"10": "Adult/Non-traditional Student"
}
},
"links": {
"self": "/field/schoolLevel"
}
}
}
# Field of study
# Get list field details.
GET /api/field/fieldOfStudy
{
"data": {
"type": "field",
"id": "fieldOfStudy",
"attributes": {
"name": "Field of study",
"type": "option",
"options": {
"1": "Agriculture and Related Sciences",
"2": "Architecture and Related Services",
"3": "Area, Ethnic, Cultural and Gender Studies",
"4": "Biological and Biomedical Sciences",
"5": "Business, Management and Marketing",
"6": "Communication and Journalism",
"7": "Computer and Information Sciences",
"8": "Construction Trades",
"9": "Education",
"10": "Engineering",
"11": "English Language and Literature",
"12": "Family and Consumer Sciences",
"13": "Foreign Languages, Literature and Linguistics",
"14": "Health Professions and Clinical Sciences",
"15": "History",
"16": "Legal Professions and Law Studies",
"17": "Liberal Arts / General Studies",
"18": "Library Science",
"19": "Mathematics and Statistics",
"20": "Mechanic and Repair Tech / Technicians",
"21": "Military Technologies",
"22": "Multi / Interdisciplinary Studies",
"23": "Natural Resources and Conservation",
"24": "Parks, Recreation, and Fitness Studies",
"25": "Personal and Culinary Services",
"26": "Philosophy and Religious Studies",
"27": "Physical Sciences",
"28": "Precision Production",
"29": "Psychology",
"30": "Public Administration and Social Service",
"31": "Security and Protective Services",
"32": "Social Sciences",
"33": "Technology Education / Industrial Arts",
"34": "Theology and Religious Vocations",
"35": "Transportation and Materials Moving",
"36": "Visual and Performing Arts",
"37": "Not Listed / Other"
}
},
"links": {
"self": "/field/fieldOfStudy"
}
}
}
# Degree type
# Get list field details.
GET /api/field/degreeType
{
"data": {
"type": "field",
"id": "degreeType",
"attributes": {
"name": "Degree type",
"type": "option",
"options": {
"1": "Undecided",
"2": "Certificate",
"3": "Associate's Degree",
"4": "Bachelor's Degree",
"5": "Graduate Certificate",
"6": "Master's Degree",
"7": "Doctoral (Ph.D.)"
}
},
"links": {
"self": "/field/degreeType"
}
}
}# GPA
# Get list field details.
GET /api/field/GPA
{
"data": {
"type": "field",
"id": "GPA",
"attributes": {
"name": "GPA",
"type": "option",
"options": {
"1": "N/A",
"2": "2.0",
"3": "2.1",
"4": "2.2",
"5": "2.3",
"6": "2.4",
"7": "2.5",
"8": "2.6",
"9": "2.7",
"10": "2.8",
"11": "2.9",
"12": "3.0",
"13": "3.1",
"14": "3.2",
"15": "3.3",
"16": "3.4",
"17": "3.5",
"18": "3.6",
"19": "3.7",
"20": "3.8",
"21": "3.9",
"22": "4.0"
}
},
"links": {
"self": "/field/GPA"
}
}
}
# Ethnicity
# Get list field details.
GET /api/field/ethnicity
{
"data": {
"type": "field",
"id": "ethnicity",
"attributes": {
"name": "Ethnicity",
"type": "option",
"options": {
"1": "Caucasian",
"2": "African American",
"3": "Hispanic / Latino",
"4": "Asian / Pacific Islander",
"5": "American Indian / Native Alaskan",
"6": "Other"
}
},
"links": {
"self": "/field/ethnicity"
}
}
}# Career goal
# Get list field details.
GET /api/field/careerGoal
{
"data": {
"type": "field",
"id": "careerGoal",
"attributes": {
"name": "Career Goal",
"type": "option",
"options": {
"1": "Art, Design or Fashion",
"2": "Beauty or Cosmetology",
"3": "Business / Marketing / Management",
"4": "Computers / IT / Technology",
"5": "Culinary Arts",
"6": "Health Care / Nursing",
"7": "Law / Criminal Justice",
"8": "Teaching / Education",
"9": "Vocational / Technical",
"10": "Other"
}
},
"links": {
"self": "/field/careerGoal"
}
}
}
# Enrolled in College
# Get list field details.
GET /api/field/enrolledInCollege
{
"data": {
"type": "field",
"id": "enrolledInCollege",
"attributes": {
"name": "Enrolled in College",
"type": "option",
"options": {
"1": "Yes",
"2": "No"
}
},
"links": {
"self": "/field/enrolledInCollege"
}
}
}
# Gender
# Get list field details.
GET /api/field/gender
{
"data": {
"type": "field",
"id": "gender",
"attributes": {
"name": "Gender",
"type": "option",
"options": {
"1": "Female",
"2": "Male",
"3": "Other"
}
},
"links": {
"self": "/field/gender"
}
}
}# Military Affiliation
# Get list field details.
GET /api/field/militaryAffiliation
{
"data": {
"type": "field",
"id": "militaryAffiliation",
"attributes": {
"name": "Military Affiliation",
"type": "option",
"options": {
"1": "None",
"2": "Army",
"3": "Navy",
"4": "Air Force",
"5": "Marines",
"6": "National Guard",
"7": "Coast Guard",
"8": "Civil Air Patrol",
"9": "Marine Corps League",
"10": "Active Military, child of",
"11": "Active Military, spouse of",
"12": "Reserve",
"13": "Reserve, child of",
"14": "Reserve, spouse of",
"15": "Veteran",
"16": "Veteran, child of",
"17": "Veteran, spouse of",
"18": "Medal of Honor recipient",
"19": "Medal of Honor, child of recipient",
"20": "Medal of Honor, spouse of recipient",
"21": "Retired",
"22": "Retired, child of",
"23": "Retired, spouse of",
"24": "Dismissed",
"25": "Dismissed, child of",
"26": "Dismissed, spouse of",
"27": "Disabled",
"28": "Disabled, child of",
"29": "Disabled, spouse of"
}
},
"links": {
"self": "/field/militaryAffiliation"
}
}
}
# Citizenship
# Get list field details.
GET /api/field/citizenship
{
"data": {
"type": "field",
"id": "citizenship",
"attributes": {
"name": "Citizenship",
"type": "option",
"options": {
"1": "U.S. Citizen",
"2": "U.S. Legal Permanent Resident",
"3": "U.S. Legal Temporary Resident (International Students)"
}
},
"links": {
"self": "/field/citizenship"
}
}
}