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

export class FinancialAidApplicationUpdateAwardRequest
{
    public award_code: string;
    public award_description: string;
    public is_awarded: boolean;
    public is_eligible: boolean;
    public award_amount?: number;
    public comments: string;
    public term: string;

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

export class FinancialAidApplicationUpdateAwardsRequest
{
    public application_uuid: string;
    public authorizing_uuid: string;
    public term: string;
    public awards: FinancialAidApplicationUpdateAwardRequest[];

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

TypeScript FinancialAidApplicationUpdateAwardsRequest 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/Application/{application_uuid}/Update/Awards HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv
Content-Length: length

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