regis

<back to all web services

FinanceBalanceRequest

Requires Authentication
Required permission:ReadAccountBalance
The following routes are available for this service:
POST/Finance/Balance/{uuid}
FinanceBalanceRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
FinanceBalanceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
first_nameformstringNo
last_nameformstringNo
emailformstringNo
current_programformstringNo
first_regent_termformstringNo
first_registered_dateformDateTime?No
last_registered_dateformDateTime?No
uuidformstringNo
total_paymentsformdecimalNo
total_chargesformdecimalNo
balanceformdecimalNo
gp_raw_balanceformdecimalNo
is_vendorformboolNo
is_customerformboolNo

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

{
	uuid: 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
		}
	},
	regent_id: 0,
	first_name: String,
	last_name: String,
	email: String,
	current_program: String,
	first_regent_term: String,
	first_registered_date: 0001-01-01,
	last_registered_date: 0001-01-01,
	uuid: String,
	total_payments: 0,
	total_charges: 0,
	balance: 0,
	gp_raw_balance: 0,
	is_vendor: False,
	is_customer: False
}