College Adaptor - Model and Controller for BOGFW
Controller to GET and POST BOG Fee Waiver information. No PUT or DELETE operations (update/delete not allowed).
Information is only posted if it does not exist.
BogFwEligibility - eligibility information for a student:
Name | Type | Purpose | Notes |
|---|---|---|---|
| cccid | String | Student's CCC ID | |
| sisTermId | String | SIS Term ID | |
Eligibility fields from BOGFW below - put these in a subclass called "eligibility". | |||
| marital_status | Enum S – Single M – Married D – Divorced X – Separated W – Widowed R – Registered Domestic Partner | Applicant’s marital status | |
| reg_dom_partner | Boolean | Whether applicant or parent is in a Registered Domestic Partnership | |
| born_before_23_year | Boolean | Whether applicant was born before <23_year_date>. | *This is a user entered but also potentially calculated field - determine whether needed/how to handle |
| married_or_rdp | Boolean | Whether applicant is currently married or in a registered domestic partnership. | *This is a combination of marital_status and red_dom_partner - determine whether needed |
| us_veteran | Boolean | Whether applicant is a veteran of the U.S. Armed Forces. | |
| dependents | Boolean | Whether applicant has dependents | |
| parents_deceased | Boolean | Whether, at age 13 or older, applicant’s parents were deceased, applicant was in foster care, or applicant was a dependent/ward of the court. | |
| emancipated_minor | Boolean | Whether applicant is currently an emancipated minor as determined by a court. | |
| legal_guardianship | Boolean | Whether applicant is in legal guardianship as determined by a court. | |
| homeless_youth_school | Boolean | Whether, on or after July 1, 2016 applicant was determined to be an unaccompanied youth who was homeless by high school or school district homeless liaison. | |
| homeless_youth_hud | Boolean | Whether, on or after July 1, 2016, applicant was determined to be an unaccompanied youth who was homeless by the director of an emergency shelter program funded by the U.S. Department of Housing and Urban Development. | |
| homeless_youth_other | Boolean | Whether, on or afterJuly 1, 2016, applicant was determined to be an unaccompanied youth who was homeless or were selfsupporting and at risk of being homeless by the director of a runaway or homeless youth basic center or transitional living program | |
| dependent_on_parent_taxes | Enum 2 - Parent(s) did not file 1 - Yes 0 - No | Whether applicant has been declared as a dependent by one or both parents in their 2015 US Tax Returns. | |
| living_with_parents | Boolean | Whether applicant currently lives with one or both parents, and/or his/her RDP. | |
| dependency_status | Enum: D - Dependent I - Independent | Whether applicant is determined to be dependent or independent. | |
| cert_veteran_affairs | Boolean | Whether applicant has certification of waiver eligibility from Veterans Affairs. | |
| cert_national_guard | Boolean | Whether applicant has certification of waiver eligibility from the National Guard. | |
| elig_medal_honor | Boolean | Whether applicant is eligible for waiver as a recipient of the Congressional Medal of Honor or as a child of a recipient. | |
| elig_sept_11 | Boolean | Whether applicant is eligible for waiver as a dependent of a victim of the September 11, 2001 terrorist attack. | |
| elig_police_fire | Boolean | Whether applicant is eligible for waiver as a dependent of a deceased law enforcement/fire suppression personnel killed in the line of duty | |
| tanf_calworks | Boolean | Whether applicant is currently receiving TANF/CalWorks. | |
| ssi_ssp | Boolean | Whether applicant is currently receiving SSI/SSP. | |
| general_assistance | Boolean | Whether applicant is currently receiving General Assistance | |
| parents_assistance | Boolean | Whether income from either TANF/CalWorks or SSI/SSP is a primary source of income for the applicant’s parents. | |
| dep_number_household | Integer | If applicant is dependent, how many persons in household? | |
| ind_number_household | Integer | If applicant is independent, how many persons in household? | |
| dep_gross_income | Integer | If applicant is dependent, what is the adjusted gross income of parent(s) for year? | |
| ind_gross_income | Integer | If applicant is independent, what is adjusted gross income of applicant (and spouse) for 2015? | |
| dep_other_income | Integer | If applicant is dependent, what is the other income of parent(s) for 2015? | |
| ind_other_income | Integer | If applicant is independent, what is other income of applicant (and spouse) for 2015? | |
| dep_total_income | Integer | If applicant is dependent, what is the total income of parent(s) for year? | |
| ind_total_income | Integer | If applicant is independent, what is total income of applicant (and spouse) for year? | |
Calculated fields from BOGFW below | |||
| elig_bogfw | Enum: A – Method A only B – Method B only D - Method D only M – Both Methods A and B N – Not eligible | Whether applicant is eligible for BOG fee waiver, and method (A, B and/or D) that determined eligibility | |
Other fields | |||
| determined_residentCA | Boolean | Whether applicant has been determined a resident of California by Admissions/Registrar | |
| determined_AB540_eligible | Boolean | Whether applicant has been determined to be AB540 eligible by Admission’s or Registrar’s Office. | |
| determined_non-res_exempt | Boolean | Whether applicant has been determined eligible for nonresident tuition exemption due to immigrant status. | |
| determined_homeless | Boolean | Whether applicant has been determined homeless by the college Financial Aid Office. |
Proposed Controllers
Endpoint | Type | Body | Return | Return Code | Additional Params | Example call |
|---|---|---|---|---|---|---|
| /bogfw | POST | BogFwEligibility | BogFwEligibility | 201 (Success - Created) 400 (Student or term not found) 409 (Conflict - already exists) | mis (required) | /bogfw?mis=001 Body = (see example above) |
| /bogfw/{cccid} | GET | BogFwEligibility | 200 (OK) 400 (Student or term not found) | mis (required) sisTermId (required) | /bogfw/ABC123?mis=001&sisTermId=2017FA |
As implemented, the below is an example returned BOGWaiver model:
{ "cccid": "ABC123", "sisTermId": "2017FA", "maritalStatus": "MARRIED", "regDomPartner": true, "bornBefore23Year": true, "marriedOrRDP": true, "usVeteran": true, "dependents": true, "parentsDeceased": true, "emancipatedMinor": true, "legalGuardianship": true, "homelessYouthSchool": true, "homelessYouthHUD": true, "homelessYouthOther": true, "dependentOnParentTaxes": "PARENTS_NOT_FILE", "livingWithParents": true, "dependencyStatus": "DEPENDENT", "certVeteranAffairs": true, "certNationalGuard": true, "eligMedalHonor": true, "eligSept11": true, "eligPoliceFire": true, "tanfCalworks": true, "ssiSSP": true, "generalAssistance": true, "parentsAssistance": true, "depNumberHousehold": 1, "indNumberHousehold": 1, "depGrossIncome": 1, "indGrossIncome": 1, "depOtherIncome": 1, "indOtherIncome": 1, "depTotalIncome": 1, "indTotalIncome": 1 }
College Adaptor API
BOGWaiver
| Name | Description | Type |
|---|---|---|
| bornBefore23Year | Whether applicant was born before <23_year_date> | boolean |
| cccid | CCC ID of the student | string |
| certNationalGuard | Whether applicant has certification of waiver eligibility from the National Guard. | boolean |
| certVeteranAffairs | Whether applicant has certification of waiver eligibility from Veterans Affairs. | boolean |
| depGrossIncome | If applicant is dependent, what is the adjusted gross income of parent(s) for year? | integer |
| depNumberHousehold | If applicant is dependent, how many persons in household? | integer |
| depOtherIncome | If applicant is dependent, what is the other income of parent(s) for 2015? | integer |
| depTotalIncome | If applicant is dependent, what is the total income of parent(s) for year? | integer |
| dependencyStatus | Whether applicant is determined to be dependent or independent. | string |
| dependentOnParentTaxes | Whether applicant has been declared as a dependent by one or both parents in their 2015 US Tax Returns. | string |
| dependents | Whether applicant has dependents | boolean |
| determinedAB540Eligible | Whether applicant has been determined to be AB540 eligible by Admission’s or Registrar’s Office. | boolean |
| determinedHomeless | Whether applicant has been determined homeless by the college Financial Aid Office. | boolean |
| determinedNonResExempt | Whether applicant has been determined eligible for nonresident tuition exemption due to immigrant status. | boolean |
| determinedResidentCA | Whether applicant has been determined a resident of California by Admissions/Registrar | boolean |
| eligMedalHonor | Whether applicant is eligible for waiver as a recipient of the Congressional Medal of Honor or as a child of a recipient. | boolean |
| eligPoliceFire | Whether applicant is eligible for waiver as a dependent of a deceased law enforcement/fire suppression personnel killed in the line of duty | boolean |
| eligSept11 | Whether applicant is eligible for waiver as a dependent of a victim of the September 11, 2001 terrorist attack. | boolean |
| eligibility | Whether applicant is eligible for BOG fee waiver, and method (A, B and/or D) that determined eligibility | string |
| emancipatedMinor | Whether applicant is currently an emancipated minor as determined by a court. | boolean |
| generalAssistance | Whether applicant is currently receiving General Assistance | boolean |
| homelessYouthHUD | Whether, on or after July 1, 2016, applicant was determined to be an unaccompanied youth who was homeless by the director of an emergency shelter program funded by the U.S. Department of Housing and Urban Development. | boolean |
| homelessYouthOther | Whether, on or afterJuly 1, 2016, applicant was determined to be an unaccompanied youth who was homeless or were selfsupporting and at risk of being homeless by the director of a runaway or homeless youth basic center or transitional living program | boolean |
| homelessYouthSchool | Whether, on or after July 1, 2016 applicant was determined to be an unaccompanied youth who was homeless by high school or school district homeless liaison. | boolean |
| indGrossIncome | If applicant is independent, what is adjusted gross income of applicant (and spouse) for 2015? | integer |
| indNumberHousehold | If applicant is independent, how many persons in household? | integer |
| indOtherIncome | If applicant is independent, what is other income of applicant (and spouse) for 2015? | integer |
| indTotalIncome | If applicant is independent, what is total income of applicant (and spouse) for year? | integer |
| legalGuardianship | Whether applicant is in legal guardianship as determined by a court. | boolean |
| livingWithParents | Whether applicant currently lives with one or both parents, and/or his/her RDP. | boolean |
| maritalStatus | Applicant’s marital status | string |
| marriedOrRDP | Whether applicant is currently married or in a registered domestic partnership | boolean |
| parentsAssistance | Whether income from either TANF/CalWorks or SSI/SSP is a primary source of income for the applicant’s parents. | boolean |
| parentsDeceased | Whether, at age 13 or older, applicant’s parents were deceased, applicant was in foster care, or applicant was a dependent/ward of the court. | boolean |
| regDomPartner | Whether applicant or parent is in a Registered Domestic Partnership | boolean |
| sisTermId | Identifier/code representing a term in the SIS | string |
| ssiSSP | Whether applicant is currently receiving SSI/SSP. | boolean |
| tanfCalworks | Whether applicant is currently receiving TANF/CalWorks. | boolean |
| usVeteran | Whether applicant is a veteran of the U.S. Armed Forces. | boolean |
FinancialAidUnits
| Name | Description | Type |
|---|---|---|
| cccid | CCC ID of the student | string |
| ceEnrollment | Student enrollment information at a teaching college | CourseExchangeEnrollment |
| sisTermId | Identifier/code representing a term in the SIS | string |
Student
Name | Description | Type |
|---|---|---|
| accountBalance | Total account balance of the student at the college | number |
| applicationStatus | Status of the student's application for the term | string |
| cccid | CCC ID of the student | string |
| cohorts | Cohorts of the student | array [Cohort] |
| concurrentlyEnrolled | boolean | |
| dspsEligible | True/False value indicating whether the student is DSPS Eligible | boolean |
| hasAttendedOrientation | True/false value indicating whether the student has attended orientation | boolean |
| hasBogfw | True/false value indicating whether the student has any active BOG Fee Waiver for the term | boolean |
| hasCaliforniaAddress | True/false value indicating whether the student has a California address on file | boolean |
| hasEducationPlan | True/false value indicating whether the student has an educational plan on file | boolean |
| hasEnglishAssessment | True/false value indicating whether the student has completed the English assessment | boolean |
| hasFinancialAidAward | True/false value indicating whether the student has any active financial aid award for the term | boolean |
| hasHold | True/false value indicating whether the student has a hold that would prevent registration for the term | boolean |
| hasMathAssessment | True/false value indicating whether the student has completed the mathematics assessment | boolean |
| incarcerated | boolean | |
| registrationDate | Date the student has been assigned to register for the term. | string |
| residentStatus | Residency status of the student for the term | string |
| sisPersonId | ID of the student in the SIS | string |
| sisTermID | string | |
| sisTermId | Identifier/code representing a term in the SIS | string |
| visaType | VISA Type of the student | string |
0 Comments