Required role: | REGISUserRole |
POST | /Finance/FinancialAid/Application/Upsert/New | ||
---|---|---|---|
POST | /Finance/FinancialAid/Application/{application_uuid}/Upsert |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
uuid | body | string | No | |
application_uuid | path | string | No | |
authorizing_uuid | body | string | No | |
citizenship | body | string | No | |
citizenship_other | body | string | No | |
permanent_resident | body | string | No | |
marital_status | body | string | No | |
gender | body | string | No | |
denomination | body | string | No | |
ethnicity | body | string | No | |
program | body | string | No | |
start_term | body | string | No | |
end_term | body | string | No | |
number_of_terms | body | int? | No | |
financial_assets | body | decimal? | No | |
spouse_income | body | decimal? | No | |
number_of_children | body | int? | No | |
employment_years | body | int? | No | |
employment_description | body | string | No | |
vocational_experience_json | body | string | No | |
vocational_direction_json | body | string | No | |
occupation_after_the_program_json | body | string | No | |
area_of_study_json | body | string | No | |
undergrad_gpa | body | decimal? | No | |
regent_gpa | body | decimal? | No | |
is_mature | body | bool | No | |
is_nonaccredited | body | bool | No | |
award_per_term | body | decimal? | No | |
amount_awarded | body | decimal? | No | |
need_score | body | int | No | |
merit_score | body | int | No | |
current_status | body | string | No | |
comments | body | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Finance/FinancialAid/Application/Upsert/New HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"uuid":"String","application_uuid":"String","authorizing_uuid":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","marital_status":"String","gender":"String","denomination":"String","ethnicity":"String","program":"String","start_term":"String","end_term":"String","number_of_terms":0,"financial_assets":0,"spouse_income":0,"number_of_children":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","undergrad_gpa":0,"regent_gpa":0,"is_mature":false,"is_nonaccredited":false,"award_per_term":0,"amount_awarded":0,"need_score":0,"merit_score":0,"current_status":"String","comments":"String"}
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}