regis

<back to all web services

FinanceAdjustmentSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/{uuid}/Adjustment/{reporting_term}/Submit
FinanceAdjustmentSubmitRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
reporting_termpathstringNo
ratesbodyList<FinanceAdjustmentRateSubmitRequest>No
descriptionbodystringNo
authorizing_uuidbodystringNo
is_financial_aidbodyboolNo
added_datebodyDateTimeNo
FinanceAdjustmentRateSubmitRequest Parameters:
NameParameterData TypeRequiredDescription
rate_idformintNo
descriptionformstringNo
chargeformdecimalNo
creditformdecimalNo
custom_glformstringNo

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

{
	uuid: String,
	reporting_term: String,
	rates: 
	[
		{
			rate_id: 0,
			description: String,
			charge: 0,
			credit: 0,
			custom_gl: String
		}
	],
	description: String,
	authorizing_uuid: String,
	is_financial_aid: False,
	added_date: 0001-01-01
}
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
	}
}