regis

<back to all web services

FinancialAidSummaryInTermRequest

Requires Authentication
Required permission:FinancialAidPermission
The following routes are available for this service:
POST/Finance/FinancialAid/Awards/{reporting_term}/Summary
FinancialAidSummaryInTermRequest Parameters:
NameParameterData TypeRequiredDescription
reporting_termpathstringNo
FinancialAidSummaryInTermResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
reporting_termformstringNo
awardsformList<FinancialAidAwardSummaryInTermResponse>No
FinancialAidAwardSummaryInTermResponse Parameters:
NameParameterData TypeRequiredDescription
award_idformintNo
award_codeformstringNo
award_descriptionformstringNo
budget_amountformdecimalNo
awarded_amountformdecimalNo
person_awardsformList<FinancialAidAwardResponse>No
FinancialAidAwardResponse Parameters:
NameParameterData TypeRequiredDescription
uuidformstringNo
regent_idformintNo
first_nameformstringNo
last_nameformstringNo
awarded_amountformdecimalNo

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	reporting_term: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
				}
			]
		}
	]
}