regis

<back to all web services

FinancialAidApplicationUpdateAwardsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/FinancialAid/Application/{application_uuid}/Update/Awards
FinancialAidApplicationUpdateAwardsRequest Parameters:
NameParameterData TypeRequiredDescription
application_uuidpathstringNo
authorizing_uuidbodystringNo
termbodystringNo
awardsbodyList<FinancialAidApplicationUpdateAwardRequest>No
FinancialAidApplicationUpdateAwardRequest Parameters:
NameParameterData TypeRequiredDescription
award_codeformstringNo
award_descriptionformstringNo
is_awardedformboolNo
is_eligibleformboolNo
award_amountformdecimal?No
commentsformstringNo
termformstringNo

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

HTTP + JSON

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

POST /Finance/FinancialAid/Application/{application_uuid}/Update/Awards HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"application_uuid":"String","authorizing_uuid":"String","term":"String","awards":[{"award_code":"String","award_description":"String","is_awarded":false,"is_eligible":false,"award_amount":0,"comments":"String","term":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}