regis

FinancialAidApplicationFileRequest

**Requires Authentication**
Required permission:	FinancialAidPermission

The following routes are available for this service:
POST	/Finance/FinancialAid/Application/{application_uuid}/{file_uuid}

"use strict";
export class FileSimpleResponse {
    /** @param {{responseStatus?:ResponseStatus,uuid?:string,name?:string,extension?:string,size?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    uuid;
    /** @type {string} */
    name;
    /** @type {string} */
    extension;
    /** @type {number} */
    size;
}
export class FileResponse extends FileSimpleResponse {
    /** @param {{type?:string,content?:string,responseStatus?:ResponseStatus,uuid?:string,name?:string,extension?:string,size?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    type;
    /** @type {string} */
    content;
}
export class FinancialAidApplicationFileRequest {
    /** @param {{application_uuid?:string,file_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    application_uuid;
    /** @type {string} */
    file_uuid;
}

JavaScript FinancialAidApplicationFileRequest 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}/{file_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	application_uuid: String,
	file_uuid: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	type: String,
	content: AA==,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	uuid: String,
	name: String,
	extension: String,
	size: 0
}