regis

FinancialAidSummaryInTermRequest

**Requires Authentication**
Required permission:	FinancialAidPermission

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

"use strict";
export class FinancialAidAwardResponse {
    /** @param {{uuid?:string,regent_id?:number,first_name?:string,last_name?:string,awarded_amount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {number} */
    awarded_amount;
}
export class FinancialAidAwardSummaryInTermResponse {
    /** @param {{award_id?:number,award_code?:string,award_description?:string,budget_amount?:number,awarded_amount?:number,person_awards?:FinancialAidAwardResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    award_id;
    /** @type {string} */
    award_code;
    /** @type {string} */
    award_description;
    /** @type {number} */
    budget_amount;
    /** @type {number} */
    awarded_amount;
    /** @type {FinancialAidAwardResponse[]} */
    person_awards;
}
export class FinancialAidSummaryInTermResponse {
    /** @param {{responseStatus?:ResponseStatus,reporting_term?:string,awards?:FinancialAidAwardSummaryInTermResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    reporting_term;
    /** @type {FinancialAidAwardSummaryInTermResponse[]} */
    awards;
}
export class FinancialAidSummaryInTermRequest {
    /** @param {{reporting_term?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    reporting_term;
}

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