regis

<back to all web services

FinancialAidApplicationFileRequest

Requires Authentication
Required permission:FinancialAidPermission
The following routes are available for this service:
POST/Finance/FinancialAid/Application/{application_uuid}/{file_uuid}
FinancialAidApplicationFileRequest Parameters:
NameParameterData TypeRequiredDescription
application_uuidpathstringNo
file_uuidpathstringNo
FileResponse Parameters:
NameParameterData TypeRequiredDescription
typeformstringNo
contentformbyte[]No
FileSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
uuidformstringNo
nameformstringNo
extensionformstringNo
sizeformlongNo

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
}