Required permission: | FinancialAidPermission |
POST | /Finance/FinancialAid/Awards/{reporting_term}/Summary |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
reporting_term | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
reporting_term | form | string | No | |
awards | form | List<FinancialAidAwardSummaryInTermResponse> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
award_id | form | int | No | |
award_code | form | string | No | |
award_description | form | string | No | |
budget_amount | form | decimal | No | |
awarded_amount | form | decimal | No | |
person_awards | form | List<FinancialAidAwardResponse> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
uuid | form | string | No | |
regent_id | form | int | No | |
first_name | form | string | No | |
last_name | form | string | No | |
awarded_amount | form | decimal | 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/Awards/{reporting_term}/Summary HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"reporting_term":"String"}
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"reporting_term":"String","awards":[{"award_id":0,"award_code":"String","award_description":"String","budget_amount":0,"awarded_amount":0,"person_awards":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","awarded_amount":0}]}]}