regis

<back to all web services

FinancialAidApplicationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/FinancialAid/Applications
FinancialAidApplicationsRequest Parameters:
NameParameterData TypeRequiredDescription
start_termbodystringNo
continuing_termbodystringNo
issued_in_termbodystringNo
available_in_termbodystringNo
done_in_termbodystringNo
no_awards_in_responsebodyboolNo
FinancialAidApplicationsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
applicationsformList<FinancialAidApplicationResponse>No
FinancialAidApplicationResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
start_termformstringNo
end_termformstringNo
number_of_termsformint?No
regent_idformintNo
uuidformstringNo
application_uuidformstringNo
awardsformList<FinancialAidApplicationAwardResponse>No
previous_awardsformList<FinancialAidApplicationAwardResponse>No
programformstringNo
genderformstringNo
first_nameformstringNo
last_nameformstringNo
emailformstringNo
citizenshipformstringNo
citizenship_otherformstringNo
permanent_residentformstringNo
ethnicityformstringNo
marital_statusformstringNo
dobformDateTime?No
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
codeformstringNo
denominationformstringNo
undergrad_gpaformdecimal?No
regent_gpaformdecimal?No
current_attempted_creditsformdecimal?No
first_term_admittedformstringNo
current_attempted_and_transferred_creditsformdecimal?No
current_award_term_attempted_creditsformdecimal?No
number_of_childrenformint?No
financial_assetsformdecimal?No
spouse_incomeformdecimal?No
employment_yearsformint?No
employment_descriptionformstringNo
vocational_experience_jsonformstringNo
vocational_direction_jsonformstringNo
occupation_after_the_program_jsonformstringNo
area_of_study_jsonformstringNo
need_scoreformintNo
merit_scoreformintNo
scoreformintNo
is_matureformboolNo
is_nonaccreditedformboolNo
award_per_termformdecimal?No
amount_awardedformdecimal?No
oncampus_tuition_owing_in_termformdecimal?No
online_tuition_owing_in_termformdecimal?No
audit_and_fees_owing_in_termformdecimal?No
amount_offeredformdecimal?No
total_amount_awardedformdecimal?No
commentsformstringNo
current_statusformstringNo
cannot_apply_againformboolNo
current_status_dateformDateTime?No
started_dateformDateTime?No
started_byformstringNo
submitted_dateformDateTime?No
submitted_byformstringNo
changed_dateformDateTime?No
changed_byformstringNo
FinancialAidApplicationAwardResponse Parameters:
NameParameterData TypeRequiredDescription
idformintNo
award_codeformstringNo
award_descriptionformstringNo
is_awardedformboolNo
is_plannedformboolNo
is_eligibleformboolNo
award_amountformdecimal?No
award_budgetformdecimal?No
commentsformstringNo
termformstringNo
awarded_byformstringNo
awarded_dateformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Finance/FinancialAid/Applications HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"start_term":"String","continuing_term":"String","issued_in_term":"String","available_in_term":"String","done_in_term":"String","no_awards_in_response":false}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"applications":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"start_term":"String","end_term":"String","number_of_terms":0,"regent_id":0,"uuid":"String","application_uuid":"String","awards":[{"id":0,"award_code":"String","award_description":"String","is_awarded":false,"is_planned":false,"is_eligible":false,"award_amount":0,"award_budget":0,"comments":"String","term":"String","awarded_by":"String","awarded_date":"0001-01-01T00:00:00.0000000"}],"previous_awards":[{"id":0,"award_code":"String","award_description":"String","is_awarded":false,"is_planned":false,"is_eligible":false,"award_amount":0,"award_budget":0,"comments":"String","term":"String","awarded_by":"String","awarded_date":"0001-01-01T00:00:00.0000000"}],"program":"String","gender":"String","first_name":"String","last_name":"String","email":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","ethnicity":"String","marital_status":"String","dob":"0001-01-01T00:00:00.0000000","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","denomination":"String","undergrad_gpa":0,"regent_gpa":0,"current_attempted_credits":0,"first_term_admitted":"String","current_attempted_and_transferred_credits":0,"current_award_term_attempted_credits":0,"number_of_children":0,"financial_assets":0,"spouse_income":0,"employment_years":0,"employment_description":"String","vocational_experience_json":"String","vocational_direction_json":"String","occupation_after_the_program_json":"String","area_of_study_json":"String","need_score":0,"merit_score":0,"score":0,"is_mature":false,"is_nonaccredited":false,"award_per_term":0,"amount_awarded":0,"oncampus_tuition_owing_in_term":0,"online_tuition_owing_in_term":0,"audit_and_fees_owing_in_term":0,"amount_offered":0,"total_amount_awarded":0,"comments":"String","current_status":"String","cannot_apply_again":false,"current_status_date":"0001-01-01T00:00:00.0000000","started_date":"0001-01-01T00:00:00.0000000","started_by":"String","submitted_date":"0001-01-01T00:00:00.0000000","submitted_by":"String","changed_date":"0001-01-01T00:00:00.0000000","changed_by":"String"}]}