| Required permission: | FinancialAidPermission |
| POST | /Finance/FinancialAid/{uuid}/Summary |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| uuid | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| uuid | form | string | No | |
| applications | form | List<FinancialAidApplicationResponse> | No | |
| awards | form | List<FinancialAidApplicationAwardResponse> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| start_term | form | string | No | |
| end_term | form | string | No | |
| number_of_terms | form | int? | No | |
| regent_id | form | int | No | |
| uuid | form | string | No | |
| application_uuid | form | string | No | |
| awards | form | List<FinancialAidApplicationAwardResponse> | No | |
| previous_awards | form | List<FinancialAidApplicationAwardResponse> | No | |
| program | form | string | No | |
| gender | form | string | No | |
| first_name | form | string | No | |
| last_name | form | string | No | |
| form | string | No | ||
| citizenship | form | string | No | |
| citizenship_other | form | string | No | |
| permanent_resident | form | string | No | |
| ethnicity | form | string | No | |
| marital_status | form | string | No | |
| dob | form | DateTime? | No | |
| addr1 | form | string | No | |
| addr2 | form | string | No | |
| city | form | string | No | |
| state | form | string | No | |
| country | form | string | No | |
| code | form | string | No | |
| denomination | form | string | No | |
| undergrad_gpa | form | decimal? | No | |
| regent_gpa | form | decimal? | No | |
| current_attempted_credits | form | decimal? | No | |
| first_term_admitted | form | string | No | |
| current_attempted_and_transferred_credits | form | decimal? | No | |
| current_award_term_attempted_credits | form | decimal? | No | |
| number_of_children | form | int? | No | |
| financial_assets | form | decimal? | No | |
| spouse_income | form | decimal? | No | |
| employment_years | form | int? | No | |
| employment_description | form | string | No | |
| vocational_experience_json | form | string | No | |
| vocational_direction_json | form | string | No | |
| occupation_after_the_program_json | form | string | No | |
| area_of_study_json | form | string | No | |
| need_score | form | int | No | |
| merit_score | form | int | No | |
| score | form | int | No | |
| is_mature | form | bool | No | |
| is_nonaccredited | form | bool | No | |
| award_per_term | form | decimal? | No | |
| amount_awarded | form | decimal? | No | |
| oncampus_tuition_owing_in_term | form | decimal? | No | |
| online_tuition_owing_in_term | form | decimal? | No | |
| audit_and_fees_owing_in_term | form | decimal? | No | |
| amount_offered | form | decimal? | No | |
| total_amount_awarded | form | decimal? | No | |
| comments | form | string | No | |
| current_status | form | string | No | |
| cannot_apply_again | form | bool | No | |
| current_status_date | form | DateTime? | No | |
| started_date | form | DateTime? | No | |
| started_by | form | string | No | |
| submitted_date | form | DateTime? | No | |
| submitted_by | form | string | No | |
| changed_date | form | DateTime? | No | |
| changed_by | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| id | form | int | No | |
| award_code | form | string | No | |
| award_description | form | string | No | |
| is_awarded | form | bool | No | |
| is_planned | form | bool | No | |
| is_eligible | form | bool | No | |
| award_amount | form | decimal? | No | |
| award_budget | form | decimal? | No | |
| comments | form | string | No | |
| term | form | string | No | |
| awarded_by | form | string | No | |
| awarded_date | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Finance/FinancialAid/{uuid}/Summary HTTP/1.1
Host: data.regent-college.edu
Accept: application/json
Content-Type: application/json
Content-Length: length
{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"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"}],"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"}]}