regis

FinancialAidSummaryInTermRequest

**Requires Authentication**
Required permission:	FinancialAidPermission

The following routes are available for this service:
POST	/Finance/FinancialAid/Awards/{reporting_term}/Summary

import Foundation
import ServiceStack

public class FinancialAidSummaryInTermRequest : Codable
{
    public var reporting_term:String

    required public init(){}
}

public class FinancialAidSummaryInTermResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var reporting_term:String
    public var awards:[FinancialAidAwardSummaryInTermResponse] = []

    required public init(){}
}

public class FinancialAidAwardSummaryInTermResponse : Codable
{
    public var award_id:Int
    public var award_code:String
    public var award_description:String
    public var budget_amount:Double
    public var awarded_amount:Double
    public var person_awards:[FinancialAidAwardResponse] = []

    required public init(){}
}

public class FinancialAidAwardResponse : Codable
{
    public var uuid:String
    public var regent_id:Int
    public var first_name:String
    public var last_name:String
    public var awarded_amount:Double

    required public init(){}
}

Swift FinancialAidSummaryInTermRequest DTOs

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
				}
			]
		}
	]
}