regis

FinancialAidSummaryInTermRequest

**Requires Authentication**
Required permission:	FinancialAidPermission

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


export class FinancialAidAwardResponse
{
    public uuid: string;
    public regent_id: number;
    public first_name: string;
    public last_name: string;
    public awarded_amount: number;

    public constructor(init?: Partial<FinancialAidAwardResponse>) { (Object as any).assign(this, init); }
}

export class FinancialAidAwardSummaryInTermResponse
{
    public award_id: number;
    public award_code: string;
    public award_description: string;
    public budget_amount: number;
    public awarded_amount: number;
    public person_awards: FinancialAidAwardResponse[];

    public constructor(init?: Partial<FinancialAidAwardSummaryInTermResponse>) { (Object as any).assign(this, init); }
}

export class FinancialAidSummaryInTermResponse
{
    public responseStatus: ResponseStatus;
    public reporting_term: string;
    public awards: FinancialAidAwardSummaryInTermResponse[];

    public constructor(init?: Partial<FinancialAidSummaryInTermResponse>) { (Object as any).assign(this, init); }
}

export class FinancialAidSummaryInTermRequest
{
    public reporting_term: string;

    public constructor(init?: Partial<FinancialAidSummaryInTermRequest>) { (Object as any).assign(this, init); }
}

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