regis

TermStatementRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/TermStatements/{uuid}/{reporting_term}

**TermStatementRequest** Parameters:
Name	Parameter	Data Type	Required
uuid	path	string	No
reporting_term	path	string	No
authorizing_uuid	body	string	No

**TermStatementResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
regent_id	form	int	No
uuid	form	string	No
name	form	string	No
addr1	form	string	No
addr2	form	string	No
city	form	string	No
state	form	string	No
country	form	string	No
code	form	string	No
reporting_term	form	string	No
reporting_term_start_date	form	DateTime	No
reporting_term_end_date	form	DateTime	No
academic_program	form	string	No
total_term_payments	form	decimal	No
total_term_charges	form	decimal	No
total_term_taxes	form	decimal	No
registrations	form	List<TermStatementRegistrationResponse>	No
charges	form	List<TermStatementChargesResponse>	No

**TermStatementRegistrationResponse** Parameters:
Name	Parameter	Data Type	Required
course_name	form	string	No
title	form	string	No
section_code	form	string	No
amount	form	decimal	No
is_audit	form	bool	No
meeting_days	form	string	No
times	form	string	No
room	form	string	No
instructor	form	string	No
status	form	string	No
cost	form	decimal	No
start_date	form	DateTime?	No
end_date	form	DateTime?	No

**TermStatementChargesResponse** Parameters:
Name	Parameter	Data Type	Required
date	form	DateTime	No
code	form	string	No
description	form	string	No
is_financial_aid	form	bool	No
charge	form	decimal	No

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

{
	uuid: String,
	reporting_term: String,
	authorizing_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,
	uuid: String,
	name: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	reporting_term: String,
	reporting_term_start_date: 0001-01-01,
	reporting_term_end_date: 0001-01-01,
	academic_program: String,
	total_term_payments: 0,
	total_term_charges: 0,
	total_term_taxes: 0,
	registrations: 
	[
		{
			course_name: String,
			title: String,
			section_code: String,
			amount: 0,
			is_audit: False,
			meeting_days: String,
			times: String,
			room: String,
			instructor: String,
			status: String,
			cost: 0,
			start_date: 0001-01-01,
			end_date: 0001-01-01
		}
	],
	charges: 
	[
		{
			date: 0001-01-01,
			code: String,
			description: String,
			is_financial_aid: False,
			charge: 0
		}
	]
}