Applicants

Applicants Resource of the CES API

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /cesapi/applicants

Version: v1

Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/{applicant_id} GET

Applicant Profile

PUT

Applicant Profile

/{applicant_id}/background GET

Applicant Confidential Background

PUT

Applicant Confidential Background

/{applicant_id}/biographical_classifications GET

Applicant Profile Biographical Classifications

PUT

Applicant Profile Biographical Classifications

/{applicant_id}/college_summaries GET

Get college summaries

POST

Add college summary

/{applicant_id}/college_summaries/{college},{start_month},{end_month} DELETE

Applicant Eduational History College Summary

PUT

Applicant College Summary

/{applicant_id}/government_records GET

Applicant Confidential Government Records

PUT

Applicant Confidential Government Records

/{applicant_id}/high_school_summaries GET

Applicant High School Summaries

POST

Applicant High School Summary

/{applicant_id}/high_school_summaries/{high_school},{start_month},{end_month},{high_school_type} DELETE

Applicant High School Summary

PUT

Applicant High School Summary

/{applicant_id}/home_addresses GET

Applicant Profile Home Addresses

/{applicant_id}/home_addresses/{address_type} PUT

Addresses

/{applicant_id}/institute_summaries GET

Applicant Religious History Institute Summaries

PUT

Applicant Religious History Institute Summaries

/{applicant_id}/international_records GET

Applicant Confidential International Records

PUT

Applicant Confidential International Records

/{applicant_id}/missions DELETE

Applicant Religious History Missions

GET

Applicant Religious History Missions

PUT

Applicant Religious History Missions

/{applicant_id}/personal_records GET

Applicant Confidential Personal Records

/{applicant_id}/phones GET

Applicant Profile Phones

/{applicant_id}/phones/{lookup_number} PUT

Phones

/{applicant_id}/seminary_summaries GET

Applicant Seminary Summary

PUT

Applicant Seminary Summary

/{applicant_id}/test_scores GET

Applicant Standardized Test Scores

Paths

Applicant Profile

GET /{applicant_id}

Tags: Applicant

Returns a CES Shared Admissions Applicant

applicant_id

External Applicant identifier

path string #/parameters/applicant_id
context

Indicates a set of subresources

query string #/parameters/context
field_sets

List which subresources are to be returned

query string #/parameters/field_sets

Uses default content-types: application/json

200 OK

An Applicant

Example for application/json
{
"background": {
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"conviction_record": {
"api_type": "modifiable",
"display_label": "Has the applicant ever been convicted?",
"value": "Y"
}
,
"criminal_convictions": [
{
"conviction": {
"api_type": "modifiable",
"display_label": "Conviction",
"value": "Petty Theft"
}
,
"conviction_explanation": {
"api_type": "modifiable",
"display_label": "Explanation",
"value": "Blah, blah, blah"
}
,
"penalties": {
"api_type": "modifiable",
"display_label": "Have all penalties, fines, and community services been completed?",
"value": "N"
}
,
"probation": {
"api_type": "modifiable",
"display_label": "Is the applicant currently under probation, parole,or under restriction?",
"value": "N"
}
,
"resolved": {
"api_type": "modifiable",
"display_label": "Has the issue been resolved with civic authorities?",
"value": "Y"
}
}
]
,
"date_time_updated": {
"api_type": "system",
"display_label": "Background information last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"discipline_explanation": {
"api_type": "modifiable",
"display_label": "Explanation",
"value": "Blah, blah, blah"
}
,
"links": {
"background__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/background",
"method": "GET",
"rel": "self"
}
,
"background__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/background",
"method": "PUT",
"rel": "background__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"plural_marriage": {
"api_type": "modifiable",
"display_label": "Are you affiliated with any group that currently advocates plural marriage?",
"value": "N"
}
,
"plural_marriage_explanation": {
"api_type": "modifiable",
"display_label": "Explanation",
"value": "Blah, blah, blah"
}
,
"sex_registry": {
"api_type": "modifiable",
"display_label": "Has the applicant ever been listed on a sex offender registry?",
"value": "N"
}
,
"sex_registry_explanation": {
"api_type": "modifiable",
"display_label": "Explanation",
"value": "Blah, blah, blah"
}
,
"university_discipline": {
"api_type": "modifiable",
"display_label": "Has the applicant ever been disciplined by a college or university?",
"value": "N"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Background information last updated by?",
"value": "764634873"
}
}
,
"basic": {
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"created_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Applicant created by?",
"value": "764634873"
}
,
"date_time_created": {
"api_type": "system",
"display_label": "Applicant created when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Applicant last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"email_address": {
"api_type": "related",
"display_label": "Email",
"related_resource": "persons",
"value": "bugsbunny22@gmail.com"
}
,
"first_name": {
"api_type": "related",
"display_label": "First Name",
"related_resource": "persons",
"value": "Bugs"
}
,
"high_school": {
"api_type": "related",
"description": "Orem High School",
"display_label": "High School",
"domain": "https://api.byu.edu/byuapi/meta/high_schools",
"related_resource": "persons",
"value": "450281"
}
,
"high_school_city": {
"api_type": "related",
"display_label": "High School City",
"related_resource": "high_schools",
"value": "Orem"
}
,
"high_school_state": {
"api_type": "related",
"description": "Utah",
"display_label": "High School State",
"related_resource": "high_schools",
"value": "UT"
}
,
"home_country": {
"api_type": "related",
"description": "United States of America",
"display_label": "Home Country",
"domain": "https://api.byu.edu/byuapi/meta/country_codes",
"related_resource": "persons",
"value": "USA"
}
,
"home_county": {
"api_type": "modifiable",
"display_label": "Home County",
"value": "Animation"
}
,
"home_state": {
"api_type": "related",
"description": "Mew York",
"display_label": "Home State",
"domain": "https://api.byu.edu/byuapi/meta/state_codes",
"related_resource": "persons",
"value": "NY"
}
,
"home_town": {
"api_type": "related",
"display_label": "Home Town",
"related_resource": "persons",
"value": "Toontown"
}
,
"links": {
"applicants__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873",
"method": "GET",
"rel": "self"
}
,
"applicants__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873",
"method": "PUT",
"rel": "applicants__modify"
}
,
"high_school_summaries__info": {
"href": "https://api.byu.edu/byuapi/meta/high_schools/450281",
"method": "GET",
"rel": "high_school_summaries__info"
}
,
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v2/764634873",
"method": "GET",
"rel": "persons__info"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"middle_name": {
"api_type": "related",
"display_label": "Middle Name",
"related_resource": "persons",
"value": "Bunny"
}
,
"person_id": {
"api_type": "related",
"display_label": "AIM Person ID",
"related_resource": "persons",
"value": "585241162"
}
,
"phone_number": {
"api_type": "related",
"display_label": "Phone Number",
"related_resource": "persons",
"value": "8014222507"
}
,
"preferred_first_name": {
"api_type": "related",
"display_label": "Preferred First Name",
"related_resource": "persons",
"value": "Bugs"
}
,
"preferred_name": {
"api_type": "derived",
"display_label": "Preferred Name",
"value": "Bugs Ithaca"
}
,
"preferred_surname": {
"api_type": "related",
"display_label": "Preferred Surname",
"related_resource": "persons",
"value": "Ithaca"
}
,
"rest_of_name": {
"api_type": "derived",
"display_label": "First/Middle Names",
"value": "Bugs Bunny"
}
,
"restricted": {
"api_type": "related",
"display_label": "Restricted Flag",
"domain": "https://api.byu.edu/byuapi/meta/restricted",
"related_resource": "persons",
"value": ""
}
,
"suffix": {
"api_type": "related",
"display_label": "Name Suffix",
"related_resource": "persons",
"value": "Esq."
}
,
"surname": {
"api_type": "related",
"display_label": "Surname",
"related_resource": "persons",
"value": "Ithaca"
}
,
"texts_okay": {
"api_type": "related",
"display_label": "Phone accepts text messages?",
"related_resource": "persons",
"value": "N"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
,
"biographical_classifications": {
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Applicant last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"fathers_level_of_education": {
"api_type": "modifiable",
"display_label": "Father's Level of Education",
"domain": "https://api.byu.edu/byuapi/meta/levels_of_education",
"value": "Some High School"
}
,
"hispanic_flag": {
"api_type": "modifiable",
"display_label": "Do you consider yourself Hispanic/Latino?",
"value": "N"
}
,
"languages": [
{
"api_type": "modifiable",
"description": "English",
"display_label": "Language Skills",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "en"
},
{
"api_type": "modifiable",
"description": "Portuguese",
"display_label": "Language Skills",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "pt"
},
{
"api_type": "modifiable",
"description": "German",
"display_label": "Language Skills",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "de"
}
]
,
"links": {
"biographical_classifications__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/biographical_classifications",
"method": "GET",
"rel": "self"
}
,
"biographical_classifications__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/biographical_classifications",
"method": "PUT",
"rel": "biographical_classifications__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"mothers_level_of_education": {
"api_type": "modifiable",
"display_label": "Mother's Level of Education",
"domain": "https://api.byu.edu/byuapi/meta/levels_of_education",
"value": "Some College/University"
}
,
"racial_categories": [
{
"api_type": "modifiable",
"display_label": "Which racial categories describe you?",
"domain": "https://api.byu.edu/byuapi/meta/racial_categories",
"value": "Asian/Asian American"
},
{
"api_type": "modifiable",
"display_label": "Which racial categories describe you?",
"domain": "https://api.byu.edu/byuapi/meta/racial_categories",
"value": "Pacific Islander"
},
{
"api_type": "modifiable",
"display_label": "Which racial categories describe you?",
"domain": "https://api.byu.edu/byuapi/meta/racial_categories",
"value": "Hawaiian/Part-Hawaiian"
}
]
,
"single_parent": {
"api_type": "modifiable",
"display_label": "Single Parent",
"value": "Y"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by?",
"value": "764634873"
}
}
,
"college_summaries": {
"links": {
"college_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/college_summaries",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 4,
"default_page_size": 50,
"max_page_size": 50,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"values": [
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"college": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "College Attended",
"domain": "https://api.byu.edu/byuapi/meta/colleges",
"key": true,
"value": "BYU-Idaho"
}
,
"college_gpa": {
"api_type": "derived",
"display_label": "GPA",
"value": "3.16"
}
,
"credit_hours_graded": {
"api_type": "modifiable",
"display_label": "Credit Hours",
"value": "34.0"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "College Attendance was last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"date_time_verified": {
"api_type": "system",
"display_label": "College Attendance was verified when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"end_month": {
"api_type": "modifiable",
"display_label": "Last Month of Attendance",
"key": true,
"value": "2013-08"
}
,
"grade_points_earned": {
"api_type": "modifiable",
"display_label": "Grade Points",
"value": "107.4"
}
,
"links": {
"college_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/college_summaries/BYU-Idaho,2013-01,2013-08",
"method": "GET",
"rel": "self"
}
,
"college_summaries__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/college_summaries/BYU-Idaho,2013-01,2013-08",
"method": "PUT",
"rel": "college_summaries__modify"
}
,
"college_summaries__remove": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/college_summaries/BYU-Idaho,2013-01,2013-08",
"method": "DELETE",
"rel": "college_summaries__remove"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"start_month": {
"api_type": "modifiable",
"display_label": "First Month of Attendance",
"key": true,
"value": "2013-01"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "College Attendance was last updated by whom?",
"value": "764634873"
}
}
]
}
,
"government_records": {
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"birth_city": {
"api_type": "modifiable",
"display_label": "Birth City",
"value": "Beijing"
}
,
"birth_country_code": {
"api_type": "related",
"description": "China, People's Republic",
"display_label": "Birth Country",
"domain": "https://api.byu.edu/byuapi/meta/country_codes",
"related_resource": "persons",
"value": "CHP"
}
,
"citizenship_country_code": {
"api_type": "related",
"description": "Canada",
"display_label": "Citizenship Country Code",
"domain": "https://api.byu.edu/byuapi/meta/country_codes",
"related_resource": "persons",
"value": "CAN"
}
,
"citizenship_status": {
"api_type": "modifiable",
"description": "International",
"display_label": "Citizenship Status",
"domain": "https://api.byu.edu/byuapi/meta/citizenship_status",
"value": "I"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Government Records last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"i20_expiration_date": {
"api_type": "related",
"display_label": "I20 Expiration Date",
"related_resource": "persons",
"value": "1981-01-21"
}
,
"links": {
"government_records__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/government_records",
"method": "GET",
"rel": "self"
}
,
"government_records__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/government_records",
"method": "PUT",
"rel": "government_records__modify"
}
,
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v2/764634873",
"method": "GET",
"rel": "persons__info"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"ssn": {
"api_type": "related",
"display_label": "SSN",
"related_resource": "persons",
"value": "987987987"
}
,
"ssn_verification_date": {
"api_type": "related",
"display_label": "SSN Verification Date",
"related_resource": "persons",
"value": "2007-02-28"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Government Records last updated by?",
"value": "764634873"
}
,
"visa_type": {
"api_type": "related",
"display_label": "Visa Type",
"domain": "https://api.byu.edu/byuapi/meta/visa_types",
"related_resource": "persons",
"value": "F-1"
}
,
"visa_type_source": {
"api_type": "related",
"display_label": "Visa Verifying Entity",
"related_resource": "persons",
"value": "HR"
}
}
,
"high_school_summaries": {
"links": {
"high_school_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/high_school_summaries",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 4,
"default_page_size": 50,
"max_page_size": 50,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"values": [
{
"ap_ib_full_classes": {
"api_type": "modifiable",
"display_label": "AP/IB Full Classes",
"value": "3"
}
,
"ap_ib_half_classes": {
"api_type": "modifiable",
"display_label": "AP/IB Half Classes",
"value": "1"
}
,
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"concurrent_enrollment": {
"api_type": "modifiable",
"display_label": "Has the student participated in concurrent enrollment classes?",
"value": "Y"
}
,
"credit_hours_graded": {
"api_type": "modifiable",
"display_label": "Credit Hours",
"value": "34.0"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "High School Information was last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"date_time_verified": {
"api_type": "system",
"display_label": "When Verified",
"value": "2014-05-11T13:45:53.200Z"
}
,
"end_month": {
"api_type": "modifiable",
"display_label": "Last Month of Attendance",
"key": true,
"value": "2013-08"
}
,
"gpa_calculated": {
"api_type": "read-only",
"display_label": "Calculated GPA",
"value": "3.75"
}
,
"gpa_overall": {
"api_type": "read-only",
"display_label": "Overall GPA",
"value": "3.75"
}
,
"grade_distribution": [
{
"credits": {
"api_type": "modifiable",
"display_label": "Credits",
"value": "6.5"
}
,
"grade": {
"api_type": "modifiable",
"display_label": "Grade",
"value": "A"
}
},
{
"credits": {
"api_type": "modifiable",
"display_label": "Credits",
"value": "4.0"
}
,
"grade": {
"api_type": "modifiable",
"display_label": "Grade",
"value": "B"
}
}
]
,
"graduation_date": {
"api_type": "modifiable",
"display_label": "High School Graduation Date",
"value": "2015-05"
}
,
"graduation_status": {
"api_type": "modifiable",
"display_label": "Have you or will you graduate?",
"value": "Y"
}
,
"high_school": {
"api_type": "modifiable",
"description": "Provo High School",
"display_label": "High School",
"domain": "https://api.byu.edu/byuapi/meta/high_schools",
"key": true,
"value": "485934"
}
,
"high_school_city": {
"api_type": "related",
"display_label": "High School City",
"related_resource": "high_school_codes",
"value": "Provo"
}
,
"high_school_gpa": {
"api_type": "modifiable",
"display_label": "High School GPA",
"value": "3.1"
}
,
"high_school_state": {
"api_type": "related",
"description": "Utah",
"display_label": "High School State",
"related_resource": "high_school_codes",
"value": "UT"
}
,
"high_school_type": {
"api_type": "modifiable",
"description": "Public High School",
"display_label": "High School Type",
"domain": "https://api.byu.edu/byuapi/meta/high_school_types",
"key": true,
"value": "Public"
}
,
"link_to_secondary_eddocs_image": {
"api_type": "modifiable",
"display_label": "Link to Secondary Education Documents Image",
"value": "https://api.byu.edu/byuapi/images/5820492"
}
,
"link_to_transcript_image": {
"api_type": "modifiable",
"display_label": "Link to Transcript Image",
"value": "https://api.byu.edu/byuapi/images/5820492"
}
,
"links": {
"high_school_codes__info": {
"href": "https://api.byu.edu/byuapi/meta/high_school_codes/485934",
"method": "GET",
"rel": "high_school_codes__info"
}
,
"high_school_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/high_school_summaries/Public,485934,2012-09,2013-05",
"method": "GET",
"rel": "self"
}
,
"high_school_summaries__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/high_school_summaries/Public,485934,2012-09,2013-05",
"method": "PUT",
"rel": "high_school_summaries__modify"
}
,
"high_school_summaries__remove": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/high_school_summaries/Public,485934,2012-09,2013-05",
"method": "DELETE",
"rel": "high_school_summaries__remove"
}
}
,
"list_of_classes": [
{
"ap_ib_flag": {
"api_type": "modifiable",
"display_label": "AP/IB Flag",
"value": "Y"
}
,
"course_name": {
"api_type": "modifiable",
"display_label": "Course Name",
"value": "English 101"
}
,
"credits": {
"api_type": "modifiable",
"display_label": "Credits",
"value": "6.5"
}
,
"grade_final": {
"api_type": "modifiable",
"display_label": "Final Grade",
"value": "A"
}
,
"grade_level": {
"api_type": "modifiable",
"display_label": "Grade Level",
"value": "10"
}
,
"grades": [
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
},
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
},
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
},
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
}
]
,
"grading_terms": {
"api_type": "modifiable",
"display_label": "Terms",
"value": "4"
}
,
"repeated": {
"api_type": "modifiable",
"display_label": "Repeated",
"value": "N"
}
,
"subject": {
"api_type": "modifiable",
"display_label": "Subject",
"value": "English"
}
}
]
,
"list_of_nonaccredited_work": [
{
"grade_level": {
"api_type": "modifiable",
"display_label": "Grade Level",
"value": "10"
}
,
"statement": {
"api_type": "modifiable",
"display_label": "Describe your non-accredited school work",
"value": "Blah, blah, blah"
}
}
]
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"start_month": {
"api_type": "modifiable",
"display_label": "First Month of Attendance",
"key": true,
"value": "2013-01"
}
,
"transcript_source": {
"api_type": "modifiable",
"display_label": "Transcript Source",
"value": "1"
}
,
"transcript_statement": {
"api_type": "modifiable",
"display_label": "Please explain you incomplete transcript data",
"value": "Blah, blah, blah"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "High School Information was last updated by whom?",
"value": "764634873"
}
,
"verified": {
"api_type": "modifiable",
"display_label": "Transcript Verified",
"value": "Y"
}
,
"verified_by_id": {
"api_type": "modifiable",
"description": "Bugs Bunny Ithaca",
"display_label": "Verified By",
"value": "764634873"
}
}
]
}
,
"home_addresses": {
"address_line_1": {
"api_type": "modifiable",
"display_label": "Address Line 1",
"value": "A-153 ASB"
}
,
"address_line_2": {
"api_type": "modifiable",
"display_label": "Address Line 2",
"value": "Provo, UT 84602"
}
,
"address_line_3": {
"api_type": "modifiable",
"display_label": "Address Line 3",
"value": ""
}
,
"address_line_4": {
"api_type": "modifiable",
"display_label": "Address Line 4",
"value": ""
}
,
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"city": {
"api_type": "modifiable",
"display_label": "City",
"value": "Provo"
}
,
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"display_label": "Country Code",
"domain": "https://api.byu.edu/byuapi/meta/country_codes",
"value": "USA"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Address last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"links": {
"home_addresses__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/home_addresses",
"method": "GET",
"rel": "self"
}
,
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v2/764634873",
"method": "GET",
"rel": "persons__info"
}
}
,
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"postal_code": {
"api_type": "modifiable",
"display_label": "Zip Code",
"value": "84602"
}
,
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"display_label": "State",
"domain": "https://api.byu.edu/byuapi/meta/state_codes",
"value": "UT"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Address last updated by?",
"value": "764634873"
}
}
,
"institute_summaries": {
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"date_time_reported": {
"api_type": "system",
"display_label": "Seminary Information as of date",
"value": "2014-05-11T13:45:53.200Z"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Seminary last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"institute_attendance": {
"api_type": "read-only",
"display_label": "Years Attended",
"value": "3"
}
,
"institute_classes": [
{
"academic_year": {
"api_type": "read-only",
"display_label": "Academic Year",
"value": "2016 Fall"
}
,
"for_credit": {
"api_type": "read-only",
"display_label": "For Credit?",
"value": "Y"
}
,
"grade": {
"api_type": "read-only",
"display_label": "Institute Grade",
"value": "A"
}
,
"institute_class": {
"api_type": "read-only",
"display_label": "Institute Class Name",
"domain": "https://api.byu.edu/byuapi/meta/institute_classes",
"value": "New Testament"
}
}
]
,
"institute_explanation": {
"api_type": "modifiable",
"display_label": "Explain your Institute Participation",
"value": "Blah, blah, blah"
}
,
"links": {
"institute_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/institute_summaries",
"method": "GET",
"rel": "self"
}
,
"institute_summaries__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/institute_summaries",
"method": "PUT",
"rel": "institute_summaries__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Seminaries last updated by?",
"value": "764634873"
}
}
,
"international_records": {
"alien_number": {
"api_type": "modifiable",
"display_label": "Alien or USCIS Number",
"value": "789789789"
}
,
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"current_us_resident": {
"api_type": "modifiable",
"display_label": "Current US Resident",
"value": "Y"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Government Records last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"links": {
"international_records__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/international_records",
"method": "GET",
"rel": "self"
}
,
"international_records__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/international_records",
"method": "PUT",
"rel": "international_records__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Government Records last updated by?",
"value": "764634873"
}
,
"visa_change_plan": {
"api_type": "modifiable",
"display_label": "Will you change the Visa if admitted?",
"value": "Y"
}
}
,
"missions": {
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Mission was last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"end_month": {
"api_type": "read-only",
"display_label": "End Month",
"value": "2013-08"
}
,
"links": {
"missions__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/missions",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"mission_language": {
"api_type": "read-only",
"description": "Spanish",
"display_label": "Mission Language",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "es"
}
,
"mission_name": {
"api_type": "read-only",
"display_label": "Mission Name",
"domain": "https://api.byu.edu/byuapi/meta/mission_names",
"value": "Mexico-Veracruz"
}
,
"mission_service": {
"api_type": "read-only",
"display_label": "Have you served or are you currently serving a mission?",
"value": "Y"
}
,
"mission_type": {
"api_type": "read-only",
"display_label": "Mission Type",
"domain": "https://api.byu.edu/byuapi/meta/mission_types",
"value": "Full-time"
}
,
"start_month": {
"api_type": "read-only",
"display_label": "Start Month",
"value": "2013-01"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Mission was last updated by whom?",
"value": "764634873"
}
}
,
"personal_records": {
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"date_of_birth": {
"api_type": "related",
"display_label": "Date of birth",
"related_resource": "persons",
"value": "1997-12-01"
}
,
"date_of_death": {
"api_type": "related",
"display_label": "Date of death",
"related_resource": "persons",
"value": "2001-12-01"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Personal records last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"deceased": {
"api_type": "related",
"display_label": "Deceased Flag",
"related_resource": "persons",
"value": " "
}
,
"links": {
"personal_records__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/personal_records",
"method": "GET",
"rel": "self"
}
,
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v2/764634873",
"method": "GET",
"rel": "persons__info"
}
}
,
"marital_status": {
"api_type": "related",
"description": "Single",
"display_label": "Marital Status",
"related_resource": "persons",
"value": "S"
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": {
"api_type": "related",
"description": "The Church of Jesus Christ of Latter-day Saints",
"display_label": "Religion",
"domain": "https://api.byu.edu/byuapi/meta/religions/v1",
"related_resource": "persons",
"value": "LDS"
}
,
"religion_tenure": {
"api_type": "derived",
"display_label": "How long have you been a member of the church?",
"value": "8.0"
}
,
"sex": {
"api_type": "related",
"display_label": "Sex",
"related_resource": "persons",
"value": "M"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Phone last updated by?",
"value": "764634873"
}
}
,
"phones": {
"links": {
"phones__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/phones",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 2,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 2,
"page_size": 2,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"values": [
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"cell_flag": {
"api_type": "related",
"display_label": "Mobile Phone?",
"related_resource": "persons",
"value": "N"
}
,
"country_code": {
"api_type": "related",
"description": "United States of America",
"display_label": "Country Code",
"domain": "https://api.byu.edu/byuapi/meta/country_codes",
"related_resource": "persons",
"value": "USA"
}
,
"country_number": {
"api_type": "related",
"display_label": "Country Number",
"related_resource": "persons",
"value": "1"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Phone last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"links": {
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v2/764634873",
"method": "GET",
"rel": "persons__info"
}
,
"phones__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/phones/8014222507",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"phone_number": {
"api_type": "related",
"display_label": "Phone Number",
"key": true,
"related_resource": "persons",
"value": "801-422-2507"
}
,
"primary_flag": {
"api_type": "related",
"display_label": "Is this the primary phone?",
"related_resource": "persons",
"value": "Y"
}
,
"texts_okay": {
"api_type": "related",
"display_label": "Texts OK?",
"related_resource": "persons",
"value": "N"
}
,
"time_code": {
"api_type": "related",
"description": "Mountain Standard Time",
"display_label": "Time Code",
"domain": "https://api.byu.edu/byuapi/meta/time_codes",
"related_resource": "persons",
"value": "MST"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Phone last updated by?",
"value": "764634873"
}
}
]
}
,
"seminary_summaries": {
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"attendance_percentage": {
"api_type": "read-only",
"display_label": "Attendance",
"value": "82.0"
}
,
"date_time_reported": {
"api_type": "system",
"display_label": "Seminary Information as of date",
"value": "2014-05-11T13:45:53.200Z"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Seminary last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"graduation_status": {
"api_type": "modifiable",
"display_label": "Have you or will you graduate?",
"value": "Y"
}
,
"links": {
"seminary_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/seminary_summaries",
"method": "GET",
"rel": "self"
}
,
"seminary_summaries__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/seminary_summaries",
"method": "PUT",
"rel": "seminary_summaries__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"seminary_classes": [
{
"academic_year": {
"api_type": "read-only",
"display_label": "Academic Year",
"value": "2016 Fall"
}
,
"seminary_class": {
"api_type": "read-only",
"display_label": "Seminary Class Name",
"domain": "https://api.byu.edu/byuapi/meta/seminary_classes",
"value": "New Testament"
}
,
"term_info": [
{
"absences": {
"api_type": "read-only",
"display_label": "Absences",
"value": "3"
}
,
"attendance": {
"api_type": "read-only",
"display_label": "Attendance",
"value": "90%"
}
,
"credit": {
"api_type": "read-only",
"display_label": "Credit",
"value": "Y"
}
,
"grade": {
"api_type": "read-only",
"display_label": "Grade",
"value": "A"
}
,
"reading": {
"api_type": "read-only",
"display_label": "Reading",
"value": "Y"
}
,
"recognition": {
"api_type": "read-only",
"display_label": "Reading",
"value": "Y"
}
,
"sessions": {
"api_type": "read-only",
"display_label": "Sessions",
"value": "30"
}
,
"term": {
"api_type": "read-only",
"display_label": "Term",
"value": "1"
}
}
]
}
]
,
"seminary_explanation": {
"api_type": "modifiable",
"display_label": "Explain your Seminary Participation",
"value": "Blah, blah, blah"
}
,
"seminary_type": {
"api_type": "read-only",
"description": "Released Time from School",
"display_label": "Seminary Type",
"domain": "https://api.byu.edu/byuapi/meta/seminary_types",
"value": "Released Time"
}
,
"teacher": {
"email": {
"api_type": "modifiable",
"display_label": "Email",
"value": "daffyduck22@gmail.com"
}
,
"language": {
"api_type": "modifiable",
"description": "Spanish",
"display_label": "Language",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "es"
}
,
"phone_number": {
"api_type": "modifiable",
"display_label": "Phone Number",
"value": "8014222507"
}
,
"teacher_name": {
"api_type": "modifiable",
"display_label": "Seminary Teacher",
"value": "John Doe"
}
,
"texts_okay": {
"api_type": "modifiable",
"display_label": "Phone accepts text messages?",
"value": "N"
}
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Seminaries last updated by?",
"value": "764634873"
}
,
"years_completed": {
"api_type": "read-only",
"display_label": "Years Completed",
"value": "3.0"
}
}
,
"test_scores": {
"links": {
"test_scores__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/test_scores",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 4,
"default_page_size": 50,
"max_page_size": 50,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"values": [
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"composite_score": {
"api_type": "read-only",
"display_label": "Composite Test Score",
"value": "25"
}
,
"date_time_reported": {
"api_type": "system",
"display_label": "Date Test Score was reported",
"value": "2014-05-11T13:45:53.200Z"
}
,
"links": {
"test_scores__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/test_scores/ACT,2015-03-12",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"test_components": [
{
"component_name": {
"api_type": "read-only",
"description": "Reading and Writing",
"display_label": "Component Name",
"domain": "https://api.byu.edu/byuapi/meta/test_component_names?test=ACT",
"value": "ENG"
}
,
"component_score": {
"api_type": "read-only",
"display_label": "Component Score",
"value": "23"
}
}
]
,
"test_date": {
"api_type": "read-only",
"display_label": "Test Date",
"key": true,
"value": "2015-03-12"
}
,
"test_name": {
"api_type": "read-only",
"display_label": "Test Name",
"domain": "https://api.byu.edu/byuapi/meta/test_names",
"key": true,
"value": "ACT"
}
}
]
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Applicant not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Profile

PUT /{applicant_id}

Tags: Applicant

Updates an Applicant

New Applicant Values

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

Applicant successfully updated

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"created_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Applicant created by?",
"value": "764634873"
}
,
"date_time_created": {
"api_type": "system",
"display_label": "Applicant created when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Applicant last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"email_address": {
"api_type": "related",
"display_label": "Email",
"related_resource": "persons",
"value": "bugsbunny22@gmail.com"
}
,
"first_name": {
"api_type": "related",
"display_label": "First Name",
"related_resource": "persons",
"value": "Bugs"
}
,
"high_school": {
"api_type": "related",
"description": "Orem High School",
"display_label": "High School",
"domain": "https://api.byu.edu/byuapi/meta/high_schools",
"related_resource": "persons",
"value": "450281"
}
,
"high_school_city": {
"api_type": "related",
"display_label": "High School City",
"related_resource": "high_schools",
"value": "Orem"
}
,
"high_school_state": {
"api_type": "related",
"description": "Utah",
"display_label": "High School State",
"related_resource": "high_schools",
"value": "UT"
}
,
"home_country": {
"api_type": "related",
"description": "United States of America",
"display_label": "Home Country",
"domain": "https://api.byu.edu/byuapi/meta/country_codes",
"related_resource": "persons",
"value": "USA"
}
,
"home_county": {
"api_type": "modifiable",
"display_label": "Home County",
"value": "Animation"
}
,
"home_state": {
"api_type": "related",
"description": "Mew York",
"display_label": "Home State",
"domain": "https://api.byu.edu/byuapi/meta/state_codes",
"related_resource": "persons",
"value": "NY"
}
,
"home_town": {
"api_type": "related",
"display_label": "Home Town",
"related_resource": "persons",
"value": "Toontown"
}
,
"links": {
"applicants__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873",
"method": "GET",
"rel": "self"
}
,
"applicants__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873",
"method": "PUT",
"rel": "applicants__modify"
}
,
"high_school_summaries__info": {
"href": "https://api.byu.edu/byuapi/meta/high_schools/450281",
"method": "GET",
"rel": "high_school_summaries__info"
}
,
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v2/764634873",
"method": "GET",
"rel": "persons__info"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"middle_name": {
"api_type": "related",
"display_label": "Middle Name",
"related_resource": "persons",
"value": "Bunny"
}
,
"person_id": {
"api_type": "related",
"display_label": "AIM Person ID",
"related_resource": "persons",
"value": "585241162"
}
,
"phone_number": {
"api_type": "related",
"display_label": "Phone Number",
"related_resource": "persons",
"value": "8014222507"
}
,
"preferred_first_name": {
"api_type": "related",
"display_label": "Preferred First Name",
"related_resource": "persons",
"value": "Bugs"
}
,
"preferred_name": {
"api_type": "derived",
"display_label": "Preferred Name",
"value": "Bugs Ithaca"
}
,
"preferred_surname": {
"api_type": "related",
"display_label": "Preferred Surname",
"related_resource": "persons",
"value": "Ithaca"
}
,
"rest_of_name": {
"api_type": "derived",
"display_label": "First/Middle Names",
"value": "Bugs Bunny"
}
,
"restricted": {
"api_type": "related",
"display_label": "Restricted Flag",
"domain": "https://api.byu.edu/byuapi/meta/restricted",
"related_resource": "persons",
"value": ""
}
,
"suffix": {
"api_type": "related",
"display_label": "Name Suffix",
"related_resource": "persons",
"value": "Esq."
}
,
"surname": {
"api_type": "related",
"display_label": "Surname",
"related_resource": "persons",
"value": "Ithaca"
}
,
"texts_okay": {
"api_type": "related",
"display_label": "Phone accepts text messages?",
"related_resource": "persons",
"value": "N"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found

There is no matching Applicant

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Confidential Background

GET /{applicant_id}/background

Tags: Background

Retrieve the self-reported background for an Applicant

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

The self-reported background for the applicant

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"conviction_record": {
"api_type": "modifiable",
"display_label": "Has the applicant ever been convicted?",
"value": "Y"
}
,
"criminal_convictions": [
{
"conviction": {
"api_type": "modifiable",
"display_label": "Conviction",
"value": "Petty Theft"
}
,
"conviction_explanation": {
"api_type": "modifiable",
"display_label": "Explanation",
"value": "Blah, blah, blah"
}
,
"penalties": {
"api_type": "modifiable",
"display_label": "Have all penalties, fines, and community services been completed?",
"value": "N"
}
,
"probation": {
"api_type": "modifiable",
"display_label": "Is the applicant currently under probation, parole,or under restriction?",
"value": "N"
}
,
"resolved": {
"api_type": "modifiable",
"display_label": "Has the issue been resolved with civic authorities?",
"value": "Y"
}
}
]
,
"date_time_updated": {
"api_type": "system",
"display_label": "Background information last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"discipline_explanation": {
"api_type": "modifiable",
"display_label": "Explanation",
"value": "Blah, blah, blah"
}
,
"links": {
"background__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/background",
"method": "GET",
"rel": "self"
}
,
"background__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/background",
"method": "PUT",
"rel": "background__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"plural_marriage": {
"api_type": "modifiable",
"display_label": "Are you affiliated with any group that currently advocates plural marriage?",
"value": "N"
}
,
"plural_marriage_explanation": {
"api_type": "modifiable",
"display_label": "Explanation",
"value": "Blah, blah, blah"
}
,
"sex_registry": {
"api_type": "modifiable",
"display_label": "Has the applicant ever been listed on a sex offender registry?",
"value": "N"
}
,
"sex_registry_explanation": {
"api_type": "modifiable",
"display_label": "Explanation",
"value": "Blah, blah, blah"
}
,
"university_discipline": {
"api_type": "modifiable",
"display_label": "Has the applicant ever been disciplined by a college or university?",
"value": "N"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Background information last updated by?",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Applicant not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Confidential Background

PUT /{applicant_id}/background

Tags: Background

Modify the self-reported background for an Applicant

The self-reported background to be updated

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

Background successfully modified

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"conviction_record": {
"api_type": "modifiable",
"display_label": "Has the applicant ever been convicted?",
"value": "Y"
}
,
"criminal_convictions": [
{
"conviction": {
"api_type": "modifiable",
"display_label": "Conviction",
"value": "Petty Theft"
}
,
"conviction_explanation": {
"api_type": "modifiable",
"display_label": "Explanation",
"value": "Blah, blah, blah"
}
,
"penalties": {
"api_type": "modifiable",
"display_label": "Have all penalties, fines, and community services been completed?",
"value": "N"
}
,
"probation": {
"api_type": "modifiable",
"display_label": "Is the applicant currently under probation, parole,or under restriction?",
"value": "N"
}
,
"resolved": {
"api_type": "modifiable",
"display_label": "Has the issue been resolved with civic authorities?",
"value": "Y"
}
}
]
,
"date_time_updated": {
"api_type": "system",
"display_label": "Background information last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"discipline_explanation": {
"api_type": "modifiable",
"display_label": "Explanation",
"value": "Blah, blah, blah"
}
,
"links": {
"background__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/background",
"method": "GET",
"rel": "self"
}
,
"background__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/background",
"method": "PUT",
"rel": "background__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"plural_marriage": {
"api_type": "modifiable",
"display_label": "Are you affiliated with any group that currently advocates plural marriage?",
"value": "N"
}
,
"plural_marriage_explanation": {
"api_type": "modifiable",
"display_label": "Explanation",
"value": "Blah, blah, blah"
}
,
"sex_registry": {
"api_type": "modifiable",
"display_label": "Has the applicant ever been listed on a sex offender registry?",
"value": "N"
}
,
"sex_registry_explanation": {
"api_type": "modifiable",
"display_label": "Explanation",
"value": "Blah, blah, blah"
}
,
"university_discipline": {
"api_type": "modifiable",
"display_label": "Has the applicant ever been disciplined by a college or university?",
"value": "N"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Background information last updated by?",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Profile Biographical Classifications

GET /{applicant_id}/biographical_classifications

Tags: Biographical Classifications

Retrieve self-reported biographical classifications for an Applicant

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

The self-reported biographical classifications for the applicant

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Applicant last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"fathers_level_of_education": {
"api_type": "modifiable",
"display_label": "Father's Level of Education",
"domain": "https://api.byu.edu/byuapi/meta/levels_of_education",
"value": "Some High School"
}
,
"hispanic_flag": {
"api_type": "modifiable",
"display_label": "Do you consider yourself Hispanic/Latino?",
"value": "N"
}
,
"languages": [
{
"api_type": "modifiable",
"description": "English",
"display_label": "Language Skills",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "en"
},
{
"api_type": "modifiable",
"description": "Portuguese",
"display_label": "Language Skills",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "pt"
},
{
"api_type": "modifiable",
"description": "German",
"display_label": "Language Skills",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "de"
}
]
,
"links": {
"biographical_classifications__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/biographical_classifications",
"method": "GET",
"rel": "self"
}
,
"biographical_classifications__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/biographical_classifications",
"method": "PUT",
"rel": "biographical_classifications__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"mothers_level_of_education": {
"api_type": "modifiable",
"display_label": "Mother's Level of Education",
"domain": "https://api.byu.edu/byuapi/meta/levels_of_education",
"value": "Some College/University"
}
,
"racial_categories": [
{
"api_type": "modifiable",
"display_label": "Which racial categories describe you?",
"domain": "https://api.byu.edu/byuapi/meta/racial_categories",
"value": "Asian/Asian American"
},
{
"api_type": "modifiable",
"display_label": "Which racial categories describe you?",
"domain": "https://api.byu.edu/byuapi/meta/racial_categories",
"value": "Pacific Islander"
},
{
"api_type": "modifiable",
"display_label": "Which racial categories describe you?",
"domain": "https://api.byu.edu/byuapi/meta/racial_categories",
"value": "Hawaiian/Part-Hawaiian"
}
]
,
"single_parent": {
"api_type": "modifiable",
"display_label": "Single Parent",
"value": "Y"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by?",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Applicant not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Profile Biographical Classifications

PUT /{applicant_id}/biographical_classifications

Tags: Biographical Classifications

Modify the self-reported biographical classifications for an Applicant

The self-reported biographical classifications to be updated

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

Biographical Classifications successfully modified

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Applicant last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"fathers_level_of_education": {
"api_type": "modifiable",
"display_label": "Father's Level of Education",
"domain": "https://api.byu.edu/byuapi/meta/levels_of_education",
"value": "Some High School"
}
,
"hispanic_flag": {
"api_type": "modifiable",
"display_label": "Do you consider yourself Hispanic/Latino?",
"value": "N"
}
,
"languages": [
{
"api_type": "modifiable",
"description": "English",
"display_label": "Language Skills",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "en"
},
{
"api_type": "modifiable",
"description": "Portuguese",
"display_label": "Language Skills",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "pt"
},
{
"api_type": "modifiable",
"description": "German",
"display_label": "Language Skills",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "de"
}
]
,
"links": {
"biographical_classifications__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/biographical_classifications",
"method": "GET",
"rel": "self"
}
,
"biographical_classifications__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/biographical_classifications",
"method": "PUT",
"rel": "biographical_classifications__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"mothers_level_of_education": {
"api_type": "modifiable",
"display_label": "Mother's Level of Education",
"domain": "https://api.byu.edu/byuapi/meta/levels_of_education",
"value": "Some College/University"
}
,
"racial_categories": [
{
"api_type": "modifiable",
"display_label": "Which racial categories describe you?",
"domain": "https://api.byu.edu/byuapi/meta/racial_categories",
"value": "Asian/Asian American"
},
{
"api_type": "modifiable",
"display_label": "Which racial categories describe you?",
"domain": "https://api.byu.edu/byuapi/meta/racial_categories",
"value": "Pacific Islander"
},
{
"api_type": "modifiable",
"display_label": "Which racial categories describe you?",
"domain": "https://api.byu.edu/byuapi/meta/racial_categories",
"value": "Hawaiian/Part-Hawaiian"
}
]
,
"single_parent": {
"api_type": "modifiable",
"display_label": "Single Parent",
"value": "Y"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Updated by?",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Get college summaries

GET /{applicant_id}/college_summaries

Tags: College Summaries

Retrieve the college history for the applicant

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

Retrieves the college histories for the applicant

Example for application/json
{
"links": {
"college_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/college_summaries",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 4,
"default_page_size": 50,
"max_page_size": 50,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"values": [
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"college": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "College Attended",
"domain": "https://api.byu.edu/byuapi/meta/colleges",
"key": true,
"value": "BYU-Idaho"
}
,
"college_gpa": {
"api_type": "derived",
"display_label": "GPA",
"value": "3.16"
}
,
"credit_hours_graded": {
"api_type": "modifiable",
"display_label": "Credit Hours",
"value": "34.0"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "College Attendance was last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"date_time_verified": {
"api_type": "system",
"display_label": "College Attendance was verified when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"end_month": {
"api_type": "modifiable",
"display_label": "Last Month of Attendance",
"key": true,
"value": "2013-08"
}
,
"grade_points_earned": {
"api_type": "modifiable",
"display_label": "Grade Points",
"value": "107.4"
}
,
"links": {
"college_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/college_summaries/BYU-Idaho,2013-01,2013-08",
"method": "GET",
"rel": "self"
}
,
"college_summaries__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/college_summaries/BYU-Idaho,2013-01,2013-08",
"method": "PUT",
"rel": "college_summaries__modify"
}
,
"college_summaries__remove": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/college_summaries/BYU-Idaho,2013-01,2013-08",
"method": "DELETE",
"rel": "college_summaries__remove"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"start_month": {
"api_type": "modifiable",
"display_label": "First Month of Attendance",
"key": true,
"value": "2013-01"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "College Attendance was last updated by whom?",
"value": "764634873"
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Applicant not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Add college summary

POST /{applicant_id}/college_summaries

Tags: College Summaries

Add a college summary for an applicant

The new college information

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

201 Created

College summary successfully added

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"college": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "College Attended",
"domain": "https://api.byu.edu/byuapi/meta/colleges",
"key": true,
"value": "BYU-Idaho"
}
,
"college_gpa": {
"api_type": "derived",
"display_label": "GPA",
"value": "3.16"
}
,
"credit_hours_graded": {
"api_type": "modifiable",
"display_label": "Credit Hours",
"value": "34.0"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "College Attendance was last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"date_time_verified": {
"api_type": "system",
"display_label": "College Attendance was verified when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"end_month": {
"api_type": "modifiable",
"display_label": "Last Month of Attendance",
"key": true,
"value": "2013-08"
}
,
"grade_points_earned": {
"api_type": "modifiable",
"display_label": "Grade Points",
"value": "107.4"
}
,
"links": {
"college_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/college_summaries/BYU-Idaho,2013-01,2013-08",
"method": "GET",
"rel": "self"
}
,
"college_summaries__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/college_summaries/BYU-Idaho,2013-01,2013-08",
"method": "PUT",
"rel": "college_summaries__modify"
}
,
"college_summaries__remove": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/college_summaries/BYU-Idaho,2013-01,2013-08",
"method": "DELETE",
"rel": "college_summaries__remove"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"start_month": {
"api_type": "modifiable",
"display_label": "First Month of Attendance",
"key": true,
"value": "2013-01"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "College Attendance was last updated by whom?",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Eduational History College Summary

DELETE /{applicant_id}/college_summaries/{college},{start_month},{end_month}

Tags: College Summaries

Remove a College Summary

applicant_id

External Applicant identifier

path string #/parameters/applicant_id
college

the College designator

path string #/parameters/college
start_month

Month enrollment started

path string #/parameters/start_month
end_month

Month enrollment ended

path string #/parameters/end_month

Uses default content-types: application/json

204 No Content

College History successfully removed

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant College Summary

PUT /{applicant_id}/college_summaries/{college},{start_month},{end_month}

Tags: College Summaries

Creates/updates a college history for the applicant

The college history to be updated

applicant_id

External Applicant identifier

path string #/parameters/applicant_id
college

the College designator

path string #/parameters/college
start_month

Month enrollment started

path string #/parameters/start_month
end_month

Month enrollment ended

path string #/parameters/end_month

Uses default content-types: application/json

200 OK

College History successfully modified

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"college": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "College Attended",
"domain": "https://api.byu.edu/byuapi/meta/colleges",
"key": true,
"value": "BYU-Idaho"
}
,
"college_gpa": {
"api_type": "derived",
"display_label": "GPA",
"value": "3.16"
}
,
"credit_hours_graded": {
"api_type": "modifiable",
"display_label": "Credit Hours",
"value": "34.0"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "College Attendance was last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"date_time_verified": {
"api_type": "system",
"display_label": "College Attendance was verified when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"end_month": {
"api_type": "modifiable",
"display_label": "Last Month of Attendance",
"key": true,
"value": "2013-08"
}
,
"grade_points_earned": {
"api_type": "modifiable",
"display_label": "Grade Points",
"value": "107.4"
}
,
"links": {
"college_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/college_summaries/BYU-Idaho,2013-01,2013-08",
"method": "GET",
"rel": "self"
}
,
"college_summaries__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/college_summaries/BYU-Idaho,2013-01,2013-08",
"method": "PUT",
"rel": "college_summaries__modify"
}
,
"college_summaries__remove": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/college_summaries/BYU-Idaho,2013-01,2013-08",
"method": "DELETE",
"rel": "college_summaries__remove"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"start_month": {
"api_type": "modifiable",
"display_label": "First Month of Attendance",
"key": true,
"value": "2013-01"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "College Attendance was last updated by whom?",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found

This is not a college attended by this Applicant

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Confidential Government Records

GET /{applicant_id}/government_records

Tags: Government Records

Retrieve government information for an Applicant

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

The government information for the applicant

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"birth_city": {
"api_type": "modifiable",
"display_label": "Birth City",
"value": "Beijing"
}
,
"birth_country_code": {
"api_type": "related",
"description": "China, People's Republic",
"display_label": "Birth Country",
"domain": "https://api.byu.edu/byuapi/meta/country_codes",
"related_resource": "persons",
"value": "CHP"
}
,
"citizenship_country_code": {
"api_type": "related",
"description": "Canada",
"display_label": "Citizenship Country Code",
"domain": "https://api.byu.edu/byuapi/meta/country_codes",
"related_resource": "persons",
"value": "CAN"
}
,
"citizenship_status": {
"api_type": "modifiable",
"description": "International",
"display_label": "Citizenship Status",
"domain": "https://api.byu.edu/byuapi/meta/citizenship_status",
"value": "I"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Government Records last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"i20_expiration_date": {
"api_type": "related",
"display_label": "I20 Expiration Date",
"related_resource": "persons",
"value": "1981-01-21"
}
,
"links": {
"government_records__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/government_records",
"method": "GET",
"rel": "self"
}
,
"government_records__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/government_records",
"method": "PUT",
"rel": "government_records__modify"
}
,
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v2/764634873",
"method": "GET",
"rel": "persons__info"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"ssn": {
"api_type": "related",
"display_label": "SSN",
"related_resource": "persons",
"value": "987987987"
}
,
"ssn_verification_date": {
"api_type": "related",
"display_label": "SSN Verification Date",
"related_resource": "persons",
"value": "2007-02-28"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Government Records last updated by?",
"value": "764634873"
}
,
"visa_type": {
"api_type": "related",
"display_label": "Visa Type",
"domain": "https://api.byu.edu/byuapi/meta/visa_types",
"related_resource": "persons",
"value": "F-1"
}
,
"visa_type_source": {
"api_type": "related",
"display_label": "Visa Verifying Entity",
"related_resource": "persons",
"value": "HR"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Applicant not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Confidential Government Records

PUT /{applicant_id}/government_records

Tags: Government Records

Modify the government information for an Applicant

The new government information

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

Government Information successfully modified

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"birth_city": {
"api_type": "modifiable",
"display_label": "Birth City",
"value": "Beijing"
}
,
"birth_country_code": {
"api_type": "related",
"description": "China, People's Republic",
"display_label": "Birth Country",
"domain": "https://api.byu.edu/byuapi/meta/country_codes",
"related_resource": "persons",
"value": "CHP"
}
,
"citizenship_country_code": {
"api_type": "related",
"description": "Canada",
"display_label": "Citizenship Country Code",
"domain": "https://api.byu.edu/byuapi/meta/country_codes",
"related_resource": "persons",
"value": "CAN"
}
,
"citizenship_status": {
"api_type": "modifiable",
"description": "International",
"display_label": "Citizenship Status",
"domain": "https://api.byu.edu/byuapi/meta/citizenship_status",
"value": "I"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Government Records last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"i20_expiration_date": {
"api_type": "related",
"display_label": "I20 Expiration Date",
"related_resource": "persons",
"value": "1981-01-21"
}
,
"links": {
"government_records__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/government_records",
"method": "GET",
"rel": "self"
}
,
"government_records__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/government_records",
"method": "PUT",
"rel": "government_records__modify"
}
,
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v2/764634873",
"method": "GET",
"rel": "persons__info"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"ssn": {
"api_type": "related",
"display_label": "SSN",
"related_resource": "persons",
"value": "987987987"
}
,
"ssn_verification_date": {
"api_type": "related",
"display_label": "SSN Verification Date",
"related_resource": "persons",
"value": "2007-02-28"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Government Records last updated by?",
"value": "764634873"
}
,
"visa_type": {
"api_type": "related",
"display_label": "Visa Type",
"domain": "https://api.byu.edu/byuapi/meta/visa_types",
"related_resource": "persons",
"value": "F-1"
}
,
"visa_type_source": {
"api_type": "related",
"display_label": "Visa Verifying Entity",
"related_resource": "persons",
"value": "HR"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant High School Summaries

GET /{applicant_id}/high_school_summaries

Tags: High School Summaries

Retrieve the High School information for an Applicant

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

The High School information for the applicant

Example for application/json
{
"links": {
"high_school_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/high_school_summaries",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 4,
"default_page_size": 50,
"max_page_size": 50,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"values": [
{
"ap_ib_full_classes": {
"api_type": "modifiable",
"display_label": "AP/IB Full Classes",
"value": "3"
}
,
"ap_ib_half_classes": {
"api_type": "modifiable",
"display_label": "AP/IB Half Classes",
"value": "1"
}
,
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"concurrent_enrollment": {
"api_type": "modifiable",
"display_label": "Has the student participated in concurrent enrollment classes?",
"value": "Y"
}
,
"credit_hours_graded": {
"api_type": "modifiable",
"display_label": "Credit Hours",
"value": "34.0"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "High School Information was last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"date_time_verified": {
"api_type": "system",
"display_label": "When Verified",
"value": "2014-05-11T13:45:53.200Z"
}
,
"end_month": {
"api_type": "modifiable",
"display_label": "Last Month of Attendance",
"key": true,
"value": "2013-08"
}
,
"gpa_calculated": {
"api_type": "read-only",
"display_label": "Calculated GPA",
"value": "3.75"
}
,
"gpa_overall": {
"api_type": "read-only",
"display_label": "Overall GPA",
"value": "3.75"
}
,
"grade_distribution": [
{
"credits": {
"api_type": "modifiable",
"display_label": "Credits",
"value": "6.5"
}
,
"grade": {
"api_type": "modifiable",
"display_label": "Grade",
"value": "A"
}
},
{
"credits": {
"api_type": "modifiable",
"display_label": "Credits",
"value": "4.0"
}
,
"grade": {
"api_type": "modifiable",
"display_label": "Grade",
"value": "B"
}
}
]
,
"graduation_date": {
"api_type": "modifiable",
"display_label": "High School Graduation Date",
"value": "2015-05"
}
,
"graduation_status": {
"api_type": "modifiable",
"display_label": "Have you or will you graduate?",
"value": "Y"
}
,
"high_school": {
"api_type": "modifiable",
"description": "Provo High School",
"display_label": "High School",
"domain": "https://api.byu.edu/byuapi/meta/high_schools",
"key": true,
"value": "485934"
}
,
"high_school_city": {
"api_type": "related",
"display_label": "High School City",
"related_resource": "high_school_codes",
"value": "Provo"
}
,
"high_school_gpa": {
"api_type": "modifiable",
"display_label": "High School GPA",
"value": "3.1"
}
,
"high_school_state": {
"api_type": "related",
"description": "Utah",
"display_label": "High School State",
"related_resource": "high_school_codes",
"value": "UT"
}
,
"high_school_type": {
"api_type": "modifiable",
"description": "Public High School",
"display_label": "High School Type",
"domain": "https://api.byu.edu/byuapi/meta/high_school_types",
"key": true,
"value": "Public"
}
,
"link_to_secondary_eddocs_image": {
"api_type": "modifiable",
"display_label": "Link to Secondary Education Documents Image",
"value": "https://api.byu.edu/byuapi/images/5820492"
}
,
"link_to_transcript_image": {
"api_type": "modifiable",
"display_label": "Link to Transcript Image",
"value": "https://api.byu.edu/byuapi/images/5820492"
}
,
"links": {
"high_school_codes__info": {
"href": "https://api.byu.edu/byuapi/meta/high_school_codes/485934",
"method": "GET",
"rel": "high_school_codes__info"
}
,
"high_school_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/high_school_summaries/Public,485934,2012-09,2013-05",
"method": "GET",
"rel": "self"
}
,
"high_school_summaries__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/high_school_summaries/Public,485934,2012-09,2013-05",
"method": "PUT",
"rel": "high_school_summaries__modify"
}
,
"high_school_summaries__remove": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/high_school_summaries/Public,485934,2012-09,2013-05",
"method": "DELETE",
"rel": "high_school_summaries__remove"
}
}
,
"list_of_classes": [
{
"ap_ib_flag": {
"api_type": "modifiable",
"display_label": "AP/IB Flag",
"value": "Y"
}
,
"course_name": {
"api_type": "modifiable",
"display_label": "Course Name",
"value": "English 101"
}
,
"credits": {
"api_type": "modifiable",
"display_label": "Credits",
"value": "6.5"
}
,
"grade_final": {
"api_type": "modifiable",
"display_label": "Final Grade",
"value": "A"
}
,
"grade_level": {
"api_type": "modifiable",
"display_label": "Grade Level",
"value": "10"
}
,
"grades": [
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
},
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
},
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
},
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
}
]
,
"grading_terms": {
"api_type": "modifiable",
"display_label": "Terms",
"value": "4"
}
,
"repeated": {
"api_type": "modifiable",
"display_label": "Repeated",
"value": "N"
}
,
"subject": {
"api_type": "modifiable",
"display_label": "Subject",
"value": "English"
}
}
]
,
"list_of_nonaccredited_work": [
{
"grade_level": {
"api_type": "modifiable",
"display_label": "Grade Level",
"value": "10"
}
,
"statement": {
"api_type": "modifiable",
"display_label": "Describe your non-accredited school work",
"value": "Blah, blah, blah"
}
}
]
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"start_month": {
"api_type": "modifiable",
"display_label": "First Month of Attendance",
"key": true,
"value": "2013-01"
}
,
"transcript_source": {
"api_type": "modifiable",
"display_label": "Transcript Source",
"value": "1"
}
,
"transcript_statement": {
"api_type": "modifiable",
"display_label": "Please explain you incomplete transcript data",
"value": "Blah, blah, blah"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "High School Information was last updated by whom?",
"value": "764634873"
}
,
"verified": {
"api_type": "modifiable",
"display_label": "Transcript Verified",
"value": "Y"
}
,
"verified_by_id": {
"api_type": "modifiable",
"description": "Bugs Bunny Ithaca",
"display_label": "Verified By",
"value": "764634873"
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Applicant not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant High School Summary

POST /{applicant_id}/high_school_summaries

Tags: High School Summaries

Add a High School Summary for an Applicant

The new High School information

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

201 Created

High school summary successfully added

Example for application/json
{
"ap_ib_full_classes": {
"api_type": "modifiable",
"display_label": "AP/IB Full Classes",
"value": "3"
}
,
"ap_ib_half_classes": {
"api_type": "modifiable",
"display_label": "AP/IB Half Classes",
"value": "1"
}
,
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"concurrent_enrollment": {
"api_type": "modifiable",
"display_label": "Has the student participated in concurrent enrollment classes?",
"value": "Y"
}
,
"credit_hours_graded": {
"api_type": "modifiable",
"display_label": "Credit Hours",
"value": "34.0"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "High School Information was last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"date_time_verified": {
"api_type": "system",
"display_label": "When Verified",
"value": "2014-05-11T13:45:53.200Z"
}
,
"end_month": {
"api_type": "modifiable",
"display_label": "Last Month of Attendance",
"key": true,
"value": "2013-08"
}
,
"gpa_calculated": {
"api_type": "read-only",
"display_label": "Calculated GPA",
"value": "3.75"
}
,
"gpa_overall": {
"api_type": "read-only",
"display_label": "Overall GPA",
"value": "3.75"
}
,
"grade_distribution": [
{
"credits": {
"api_type": "modifiable",
"display_label": "Credits",
"value": "6.5"
}
,
"grade": {
"api_type": "modifiable",
"display_label": "Grade",
"value": "A"
}
},
{
"credits": {
"api_type": "modifiable",
"display_label": "Credits",
"value": "4.0"
}
,
"grade": {
"api_type": "modifiable",
"display_label": "Grade",
"value": "B"
}
}
]
,
"graduation_date": {
"api_type": "modifiable",
"display_label": "High School Graduation Date",
"value": "2015-05"
}
,
"graduation_status": {
"api_type": "modifiable",
"display_label": "Have you or will you graduate?",
"value": "Y"
}
,
"high_school": {
"api_type": "modifiable",
"description": "Provo High School",
"display_label": "High School",
"domain": "https://api.byu.edu/byuapi/meta/high_schools",
"key": true,
"value": "485934"
}
,
"high_school_city": {
"api_type": "related",
"display_label": "High School City",
"related_resource": "high_school_codes",
"value": "Provo"
}
,
"high_school_gpa": {
"api_type": "modifiable",
"display_label": "High School GPA",
"value": "3.1"
}
,
"high_school_state": {
"api_type": "related",
"description": "Utah",
"display_label": "High School State",
"related_resource": "high_school_codes",
"value": "UT"
}
,
"high_school_type": {
"api_type": "modifiable",
"description": "Public High School",
"display_label": "High School Type",
"domain": "https://api.byu.edu/byuapi/meta/high_school_types",
"key": true,
"value": "Public"
}
,
"link_to_secondary_eddocs_image": {
"api_type": "modifiable",
"display_label": "Link to Secondary Education Documents Image",
"value": "https://api.byu.edu/byuapi/images/5820492"
}
,
"link_to_transcript_image": {
"api_type": "modifiable",
"display_label": "Link to Transcript Image",
"value": "https://api.byu.edu/byuapi/images/5820492"
}
,
"links": {
"high_school_codes__info": {
"href": "https://api.byu.edu/byuapi/meta/high_school_codes/485934",
"method": "GET",
"rel": "high_school_codes__info"
}
,
"high_school_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/high_school_summaries/Public,485934,2012-09,2013-05",
"method": "GET",
"rel": "self"
}
,
"high_school_summaries__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/high_school_summaries/Public,485934,2012-09,2013-05",
"method": "PUT",
"rel": "high_school_summaries__modify"
}
,
"high_school_summaries__remove": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/high_school_summaries/Public,485934,2012-09,2013-05",
"method": "DELETE",
"rel": "high_school_summaries__remove"
}
}
,
"list_of_classes": [
{
"ap_ib_flag": {
"api_type": "modifiable",
"display_label": "AP/IB Flag",
"value": "Y"
}
,
"course_name": {
"api_type": "modifiable",
"display_label": "Course Name",
"value": "English 101"
}
,
"credits": {
"api_type": "modifiable",
"display_label": "Credits",
"value": "6.5"
}
,
"grade_final": {
"api_type": "modifiable",
"display_label": "Final Grade",
"value": "A"
}
,
"grade_level": {
"api_type": "modifiable",
"display_label": "Grade Level",
"value": "10"
}
,
"grades": [
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
},
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
},
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
},
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
}
]
,
"grading_terms": {
"api_type": "modifiable",
"display_label": "Terms",
"value": "4"
}
,
"repeated": {
"api_type": "modifiable",
"display_label": "Repeated",
"value": "N"
}
,
"subject": {
"api_type": "modifiable",
"display_label": "Subject",
"value": "English"
}
}
]
,
"list_of_nonaccredited_work": [
{
"grade_level": {
"api_type": "modifiable",
"display_label": "Grade Level",
"value": "10"
}
,
"statement": {
"api_type": "modifiable",
"display_label": "Describe your non-accredited school work",
"value": "Blah, blah, blah"
}
}
]
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"start_month": {
"api_type": "modifiable",
"display_label": "First Month of Attendance",
"key": true,
"value": "2013-01"
}
,
"transcript_source": {
"api_type": "modifiable",
"display_label": "Transcript Source",
"value": "1"
}
,
"transcript_statement": {
"api_type": "modifiable",
"display_label": "Please explain you incomplete transcript data",
"value": "Blah, blah, blah"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "High School Information was last updated by whom?",
"value": "764634873"
}
,
"verified": {
"api_type": "modifiable",
"display_label": "Transcript Verified",
"value": "Y"
}
,
"verified_by_id": {
"api_type": "modifiable",
"description": "Bugs Bunny Ithaca",
"display_label": "Verified By",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant High School Summary

DELETE /{applicant_id}/high_school_summaries/{high_school},{start_month},{end_month},{high_school_type}

Tags: High School Summaries

Delete a High School

applicant_id

External Applicant identifier

path string #/parameters/applicant_id
high_school_type

School Type

path string #/parameters/high_school_type
high_school

High School Identifier

path string #/parameters/high_school
start_month

Month enrollment started

path string #/parameters/start_month
end_month

Month enrollment ended

path string #/parameters/end_month

Uses default content-types: application/json

204 No Content

High School successfully removed

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant High School Summary

PUT /{applicant_id}/high_school_summaries/{high_school},{start_month},{end_month},{high_school_type}

Tags: High School Summaries

Modify the High School information for an Applicant

The new High School information

applicant_id

External Applicant identifier

path string #/parameters/applicant_id
high_school_type

School Type

path string #/parameters/high_school_type
high_school

High School Identifier

path string #/parameters/high_school
start_month

Month enrollment started

path string #/parameters/start_month
end_month

Month enrollment ended

path string #/parameters/end_month

Uses default content-types: application/json

200 OK

High School information successfully modified

Example for application/json
{
"ap_ib_full_classes": {
"api_type": "modifiable",
"display_label": "AP/IB Full Classes",
"value": "3"
}
,
"ap_ib_half_classes": {
"api_type": "modifiable",
"display_label": "AP/IB Half Classes",
"value": "1"
}
,
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"concurrent_enrollment": {
"api_type": "modifiable",
"display_label": "Has the student participated in concurrent enrollment classes?",
"value": "Y"
}
,
"credit_hours_graded": {
"api_type": "modifiable",
"display_label": "Credit Hours",
"value": "34.0"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "High School Information was last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"date_time_verified": {
"api_type": "system",
"display_label": "When Verified",
"value": "2014-05-11T13:45:53.200Z"
}
,
"end_month": {
"api_type": "modifiable",
"display_label": "Last Month of Attendance",
"key": true,
"value": "2013-08"
}
,
"gpa_calculated": {
"api_type": "read-only",
"display_label": "Calculated GPA",
"value": "3.75"
}
,
"gpa_overall": {
"api_type": "read-only",
"display_label": "Overall GPA",
"value": "3.75"
}
,
"grade_distribution": [
{
"credits": {
"api_type": "modifiable",
"display_label": "Credits",
"value": "6.5"
}
,
"grade": {
"api_type": "modifiable",
"display_label": "Grade",
"value": "A"
}
},
{
"credits": {
"api_type": "modifiable",
"display_label": "Credits",
"value": "4.0"
}
,
"grade": {
"api_type": "modifiable",
"display_label": "Grade",
"value": "B"
}
}
]
,
"graduation_date": {
"api_type": "modifiable",
"display_label": "High School Graduation Date",
"value": "2015-05"
}
,
"graduation_status": {
"api_type": "modifiable",
"display_label": "Have you or will you graduate?",
"value": "Y"
}
,
"high_school": {
"api_type": "modifiable",
"description": "Provo High School",
"display_label": "High School",
"domain": "https://api.byu.edu/byuapi/meta/high_schools",
"key": true,
"value": "485934"
}
,
"high_school_city": {
"api_type": "related",
"display_label": "High School City",
"related_resource": "high_school_codes",
"value": "Provo"
}
,
"high_school_gpa": {
"api_type": "modifiable",
"display_label": "High School GPA",
"value": "3.1"
}
,
"high_school_state": {
"api_type": "related",
"description": "Utah",
"display_label": "High School State",
"related_resource": "high_school_codes",
"value": "UT"
}
,
"high_school_type": {
"api_type": "modifiable",
"description": "Public High School",
"display_label": "High School Type",
"domain": "https://api.byu.edu/byuapi/meta/high_school_types",
"key": true,
"value": "Public"
}
,
"link_to_secondary_eddocs_image": {
"api_type": "modifiable",
"display_label": "Link to Secondary Education Documents Image",
"value": "https://api.byu.edu/byuapi/images/5820492"
}
,
"link_to_transcript_image": {
"api_type": "modifiable",
"display_label": "Link to Transcript Image",
"value": "https://api.byu.edu/byuapi/images/5820492"
}
,
"links": {
"high_school_codes__info": {
"href": "https://api.byu.edu/byuapi/meta/high_school_codes/485934",
"method": "GET",
"rel": "high_school_codes__info"
}
,
"high_school_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/high_school_summaries/Public,485934,2012-09,2013-05",
"method": "GET",
"rel": "self"
}
,
"high_school_summaries__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/high_school_summaries/Public,485934,2012-09,2013-05",
"method": "PUT",
"rel": "high_school_summaries__modify"
}
,
"high_school_summaries__remove": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/high_school_summaries/Public,485934,2012-09,2013-05",
"method": "DELETE",
"rel": "high_school_summaries__remove"
}
}
,
"list_of_classes": [
{
"ap_ib_flag": {
"api_type": "modifiable",
"display_label": "AP/IB Flag",
"value": "Y"
}
,
"course_name": {
"api_type": "modifiable",
"display_label": "Course Name",
"value": "English 101"
}
,
"credits": {
"api_type": "modifiable",
"display_label": "Credits",
"value": "6.5"
}
,
"grade_final": {
"api_type": "modifiable",
"display_label": "Final Grade",
"value": "A"
}
,
"grade_level": {
"api_type": "modifiable",
"display_label": "Grade Level",
"value": "10"
}
,
"grades": [
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
},
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
},
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
},
{
"api_type": "modifiable",
"display_label": "Grades",
"value": "A"
}
]
,
"grading_terms": {
"api_type": "modifiable",
"display_label": "Terms",
"value": "4"
}
,
"repeated": {
"api_type": "modifiable",
"display_label": "Repeated",
"value": "N"
}
,
"subject": {
"api_type": "modifiable",
"display_label": "Subject",
"value": "English"
}
}
]
,
"list_of_nonaccredited_work": [
{
"grade_level": {
"api_type": "modifiable",
"display_label": "Grade Level",
"value": "10"
}
,
"statement": {
"api_type": "modifiable",
"display_label": "Describe your non-accredited school work",
"value": "Blah, blah, blah"
}
}
]
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"start_month": {
"api_type": "modifiable",
"display_label": "First Month of Attendance",
"key": true,
"value": "2013-01"
}
,
"transcript_source": {
"api_type": "modifiable",
"display_label": "Transcript Source",
"value": "1"
}
,
"transcript_statement": {
"api_type": "modifiable",
"display_label": "Please explain you incomplete transcript data",
"value": "Blah, blah, blah"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "High School Information was last updated by whom?",
"value": "764634873"
}
,
"verified": {
"api_type": "modifiable",
"display_label": "Transcript Verified",
"value": "Y"
}
,
"verified_by_id": {
"api_type": "modifiable",
"description": "Bugs Bunny Ithaca",
"display_label": "Verified By",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Profile Home Addresses

GET /{applicant_id}/home_addresses

Tags: Home Addresses

Retrieve the home address

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

The home address for the applicant

Example for application/json
{
"address_line_1": {
"api_type": "modifiable",
"display_label": "Address Line 1",
"value": "A-153 ASB"
}
,
"address_line_2": {
"api_type": "modifiable",
"display_label": "Address Line 2",
"value": "Provo, UT 84602"
}
,
"address_line_3": {
"api_type": "modifiable",
"display_label": "Address Line 3",
"value": ""
}
,
"address_line_4": {
"api_type": "modifiable",
"display_label": "Address Line 4",
"value": ""
}
,
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"city": {
"api_type": "modifiable",
"display_label": "City",
"value": "Provo"
}
,
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"display_label": "Country Code",
"domain": "https://api.byu.edu/byuapi/meta/country_codes",
"value": "USA"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Address last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"links": {
"home_addresses__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/home_addresses",
"method": "GET",
"rel": "self"
}
,
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v2/764634873",
"method": "GET",
"rel": "persons__info"
}
}
,
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"postal_code": {
"api_type": "modifiable",
"display_label": "Zip Code",
"value": "84602"
}
,
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"display_label": "State",
"domain": "https://api.byu.edu/byuapi/meta/state_codes",
"value": "UT"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Address last updated by?",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Applicant not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Addresses

PUT /{applicant_id}/home_addresses/{address_type}

Tags: Home Addresses

Modifies or creates an address for the specified BYU ID and address_type

The address values to be set

applicant_id

External Applicant identifier

path string #/parameters/applicant_id
address_type

The type of address

path string , x ∈ { MAL , PRM , RES , WRK }

Uses default content-types: application/json

200 OK

The home address for the applicant

Example for application/json
{
"address_line_1": {
"api_type": "modifiable",
"display_label": "Address Line 1",
"value": "A-153 ASB"
}
,
"address_line_2": {
"api_type": "modifiable",
"display_label": "Address Line 2",
"value": "Provo, UT 84602"
}
,
"address_line_3": {
"api_type": "modifiable",
"display_label": "Address Line 3",
"value": ""
}
,
"address_line_4": {
"api_type": "modifiable",
"display_label": "Address Line 4",
"value": ""
}
,
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"city": {
"api_type": "modifiable",
"display_label": "City",
"value": "Provo"
}
,
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"display_label": "Country Code",
"domain": "https://api.byu.edu/byuapi/meta/country_codes",
"value": "USA"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Address last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"links": {
"home_addresses__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/home_addresses",
"method": "GET",
"rel": "self"
}
,
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v2/764634873",
"method": "GET",
"rel": "persons__info"
}
}
,
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"postal_code": {
"api_type": "modifiable",
"display_label": "Zip Code",
"value": "84602"
}
,
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"display_label": "State",
"domain": "https://api.byu.edu/byuapi/meta/state_codes",
"value": "UT"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Address last updated by?",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Applicant not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Religious History Institute Summaries

GET /{applicant_id}/institute_summaries

Tags: Institute Summaries

Retrieve the Institute information for an Applicant

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

The Institute information for the applicant

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"date_time_reported": {
"api_type": "system",
"display_label": "Seminary Information as of date",
"value": "2014-05-11T13:45:53.200Z"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Seminary last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"institute_attendance": {
"api_type": "read-only",
"display_label": "Years Attended",
"value": "3"
}
,
"institute_classes": [
{
"academic_year": {
"api_type": "read-only",
"display_label": "Academic Year",
"value": "2016 Fall"
}
,
"for_credit": {
"api_type": "read-only",
"display_label": "For Credit?",
"value": "Y"
}
,
"grade": {
"api_type": "read-only",
"display_label": "Institute Grade",
"value": "A"
}
,
"institute_class": {
"api_type": "read-only",
"display_label": "Institute Class Name",
"domain": "https://api.byu.edu/byuapi/meta/institute_classes",
"value": "New Testament"
}
}
]
,
"institute_explanation": {
"api_type": "modifiable",
"display_label": "Explain your Institute Participation",
"value": "Blah, blah, blah"
}
,
"links": {
"institute_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/institute_summaries",
"method": "GET",
"rel": "self"
}
,
"institute_summaries__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/institute_summaries",
"method": "PUT",
"rel": "institute_summaries__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Seminaries last updated by?",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Applicant not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Religious History Institute Summaries

PUT /{applicant_id}/institute_summaries

Tags: Institute Summaries

Modify the Institute information for an Applicant

The new Institute information

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

Institute information successfully modified

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"date_time_reported": {
"api_type": "system",
"display_label": "Seminary Information as of date",
"value": "2014-05-11T13:45:53.200Z"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Seminary last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"institute_attendance": {
"api_type": "read-only",
"display_label": "Years Attended",
"value": "3"
}
,
"institute_classes": [
{
"academic_year": {
"api_type": "read-only",
"display_label": "Academic Year",
"value": "2016 Fall"
}
,
"for_credit": {
"api_type": "read-only",
"display_label": "For Credit?",
"value": "Y"
}
,
"grade": {
"api_type": "read-only",
"display_label": "Institute Grade",
"value": "A"
}
,
"institute_class": {
"api_type": "read-only",
"display_label": "Institute Class Name",
"domain": "https://api.byu.edu/byuapi/meta/institute_classes",
"value": "New Testament"
}
}
]
,
"institute_explanation": {
"api_type": "modifiable",
"display_label": "Explain your Institute Participation",
"value": "Blah, blah, blah"
}
,
"links": {
"institute_summaries__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/institute_summaries",
"method": "GET",
"rel": "self"
}
,
"institute_summaries__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/institute_summaries",
"method": "PUT",
"rel": "institute_summaries__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Seminaries last updated by?",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Confidential International Records

GET /{applicant_id}/international_records

Tags: International Records

Retrieve international information for an Applicant

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

The international information for the applicant

Example for application/json
{
"alien_number": {
"api_type": "modifiable",
"display_label": "Alien or USCIS Number",
"value": "789789789"
}
,
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"current_us_resident": {
"api_type": "modifiable",
"display_label": "Current US Resident",
"value": "Y"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Government Records last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"links": {
"international_records__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/international_records",
"method": "GET",
"rel": "self"
}
,
"international_records__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/international_records",
"method": "PUT",
"rel": "international_records__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Government Records last updated by?",
"value": "764634873"
}
,
"visa_change_plan": {
"api_type": "modifiable",
"display_label": "Will you change the Visa if admitted?",
"value": "Y"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Applicant not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Confidential International Records

PUT /{applicant_id}/international_records

Tags: International Records

Modify the international information for an Applicant

The new international information

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

International Information successfully modified

Example for application/json
{
"alien_number": {
"api_type": "modifiable",
"display_label": "Alien or USCIS Number",
"value": "789789789"
}
,
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"current_us_resident": {
"api_type": "modifiable",
"display_label": "Current US Resident",
"value": "Y"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Government Records last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"links": {
"international_records__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/international_records",
"method": "GET",
"rel": "self"
}
,
"international_records__modify": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/international_records",
"method": "PUT",
"rel": "international_records__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Government Records last updated by?",
"value": "764634873"
}
,
"visa_change_plan": {
"api_type": "modifiable",
"display_label": "Will you change the Visa if admitted?",
"value": "Y"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Religious History Missions

DELETE /{applicant_id}/missions

Tags: Missions

Delete Mission information

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

204 No Content

Mission successfully removed

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Religious History Missions

GET /{applicant_id}/missions

Tags: Missions

Retrieve the Mission for an Applicant

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

The Mission for the applicant

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Mission was last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"end_month": {
"api_type": "read-only",
"display_label": "End Month",
"value": "2013-08"
}
,
"links": {
"missions__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/missions",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"mission_language": {
"api_type": "read-only",
"description": "Spanish",
"display_label": "Mission Language",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "es"
}
,
"mission_name": {
"api_type": "read-only",
"display_label": "Mission Name",
"domain": "https://api.byu.edu/byuapi/meta/mission_names",
"value": "Mexico-Veracruz"
}
,
"mission_service": {
"api_type": "read-only",
"display_label": "Have you served or are you currently serving a mission?",
"value": "Y"
}
,
"mission_type": {
"api_type": "read-only",
"display_label": "Mission Type",
"domain": "https://api.byu.edu/byuapi/meta/mission_types",
"value": "Full-time"
}
,
"start_month": {
"api_type": "read-only",
"display_label": "Start Month",
"value": "2013-01"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Mission was last updated by whom?",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Applicant not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Religious History Missions

PUT /{applicant_id}/missions

Tags: Missions

Modify the Mission for an Applicant

The new Mission information

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

Mission successfully modified

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Mission was last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"end_month": {
"api_type": "read-only",
"display_label": "End Month",
"value": "2013-08"
}
,
"links": {
"missions__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/missions",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"mission_language": {
"api_type": "read-only",
"description": "Spanish",
"display_label": "Mission Language",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "es"
}
,
"mission_name": {
"api_type": "read-only",
"display_label": "Mission Name",
"domain": "https://api.byu.edu/byuapi/meta/mission_names",
"value": "Mexico-Veracruz"
}
,
"mission_service": {
"api_type": "read-only",
"display_label": "Have you served or are you currently serving a mission?",
"value": "Y"
}
,
"mission_type": {
"api_type": "read-only",
"display_label": "Mission Type",
"domain": "https://api.byu.edu/byuapi/meta/mission_types",
"value": "Full-time"
}
,
"start_month": {
"api_type": "read-only",
"display_label": "Start Month",
"value": "2013-01"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Mission was last updated by whom?",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Confidential Personal Records

GET /{applicant_id}/personal_records

Tags: Personal Records

Retrieve personal information for an Applicant

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

The government information for the applicant

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"date_of_birth": {
"api_type": "related",
"display_label": "Date of birth",
"related_resource": "persons",
"value": "1997-12-01"
}
,
"date_of_death": {
"api_type": "related",
"display_label": "Date of death",
"related_resource": "persons",
"value": "2001-12-01"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Personal records last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"deceased": {
"api_type": "related",
"display_label": "Deceased Flag",
"related_resource": "persons",
"value": " "
}
,
"links": {
"personal_records__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/personal_records",
"method": "GET",
"rel": "self"
}
,
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v2/764634873",
"method": "GET",
"rel": "persons__info"
}
}
,
"marital_status": {
"api_type": "related",
"description": "Single",
"display_label": "Marital Status",
"related_resource": "persons",
"value": "S"
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": {
"api_type": "related",
"description": "The Church of Jesus Christ of Latter-day Saints",
"display_label": "Religion",
"domain": "https://api.byu.edu/byuapi/meta/religions/v1",
"related_resource": "persons",
"value": "LDS"
}
,
"religion_tenure": {
"api_type": "derived",
"display_label": "How long have you been a member of the church?",
"value": "8.0"
}
,
"sex": {
"api_type": "related",
"display_label": "Sex",
"related_resource": "persons",
"value": "M"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Phone last updated by?",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Applicant not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Applicant Profile Phones

GET /{applicant_id}/phones

Tags: Phones

Retrieve the phone numbers

applicant_id

External Applicant identifier

path string #/parameters/applicant_id

Uses default content-types: application/json

200 OK

Retrieves the phones for the applicant

Example for application/json
{
"links": {
"phones__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/phones",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 2,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 2,
"page_size": 2,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"values": [
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"cell_flag": {
"api_type": "related",
"display_label": "Mobile Phone?",
"related_resource": "persons",
"value": "N"
}
,
"country_code": {
"api_type": "related",
"description": "United States of America",
"display_label": "Country Code",
"domain": "https://api.byu.edu/byuapi/meta/country_codes",
"related_resource": "persons",
"value": "USA"
}
,
"country_number": {
"api_type": "related",
"display_label": "Country Number",
"related_resource": "persons",
"value": "1"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Phone last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"links": {
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v2/764634873",
"method": "GET",
"rel": "persons__info"
}
,
"phones__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/phones/8014222507",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"phone_number": {
"api_type": "related",
"display_label": "Phone Number",
"key": true,
"related_resource": "persons",
"value": "801-422-2507"
}
,
"primary_flag": {
"api_type": "related",
"display_label": "Is this the primary phone?",
"related_resource": "persons",
"value": "Y"
}
,
"texts_okay": {
"api_type": "related",
"display_label": "Texts OK?",
"related_resource": "persons",
"value": "N"
}
,
"time_code": {
"api_type": "related",
"description": "Mountain Standard Time",
"display_label": "Time Code",
"domain": "https://api.byu.edu/byuapi/meta/time_codes",
"related_resource": "persons",
"value": "MST"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Phone last updated by?",
"value": "764634873"
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Applicant not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Phones

PUT /{applicant_id}/phones/{lookup_number}

Tags: Phones

Sets phone information for a specific person/phone number

The phone information to be updated or created

applicant_id

External Applicant identifier

path string #/parameters/applicant_id
lookup_number

The person's phone number, numbers only

path string , must match ^[0-9]{1,30}$

Uses default content-types: application/json

200 OK

Phone successfully updated

Example for application/json
{
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"key": true,
"value": "764634873"
}
,
"cell_flag": {
"api_type": "related",
"display_label": "Mobile Phone?",
"related_resource": "persons",
"value": "N"
}
,
"country_code": {
"api_type": "related",
"description": "United States of America",
"display_label": "Country Code",
"domain": "https://api.byu.edu/byuapi/meta/country_codes",
"related_resource": "persons",
"value": "USA"
}
,
"country_number": {
"api_type": "related",
"display_label": "Country Number",
"related_resource": "persons",
"value": "1"
}
,
"date_time_updated": {
"api_type": "system",
"display_label": "Phone last updated when?",
"value": "2014-05-11T13:45:53.200Z"
}
,
"links": {
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v2/764634873",
"method": "GET",
"rel": "persons__info"
}
,
"phones__info": {
"href": "https://api.byu.edu/cesapi/applicants/v2/764634873/phones/8014222507",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"phone_number": {
"api_type": "related",
"display_label": "Phone Number",
"key": true,
"related_resource": "persons",
"value": "801-422-2507"
}
,
"primary_flag": {
"api_type": "related",
"display_label": "Is this the primary phone?",
"related_resource": "persons",
"value": "Y"
}
,
"texts_okay": {
"api_type": "related",
"display_label": "Texts OK?",
"related_resource": "persons",
"value": "N"
}
,
"time_code": {
"api_type": "related",
"description": "Mountain Standard Time",
"display_label": "Time Code",
"domain": "https://api.byu.edu/byuapi/meta/time_codes",
"related_resource": "persons",
"value": "MST"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Phone last updated by?",
"value": "764634873"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

Applicant not found

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error