regis

TermStatementRequest

**Requires Authentication**
Required role:	REGISUserRole

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

"use strict";
export class TermStatementRegistrationResponse {
    /** @param {{course_name?:string,title?:string,section_code?:string,amount?:number,is_audit?:boolean,meeting_days?:string,times?:string,room?:string,instructor?:string,status?:string,cost?:number,start_date?:string,end_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    course_name;
    /** @type {string} */
    title;
    /** @type {string} */
    section_code;
    /** @type {number} */
    amount;
    /** @type {boolean} */
    is_audit;
    /** @type {string} */
    meeting_days;
    /** @type {string} */
    times;
    /** @type {string} */
    room;
    /** @type {string} */
    instructor;
    /** @type {string} */
    status;
    /** @type {number} */
    cost;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
}
export class TermStatementChargesResponse {
    /** @param {{date?:string,code?:string,description?:string,is_financial_aid?:boolean,charge?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    date;
    /** @type {string} */
    code;
    /** @type {string} */
    description;
    /** @type {boolean} */
    is_financial_aid;
    /** @type {number} */
    charge;
}
export class TermStatementResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,name?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,reporting_term?:string,reporting_term_start_date?:string,reporting_term_end_date?:string,academic_program?:string,total_term_payments?:number,total_term_charges?:number,total_term_taxes?:number,registrations?:TermStatementRegistrationResponse[],charges?:TermStatementChargesResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {string} */
    name;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    reporting_term_start_date;
    /** @type {string} */
    reporting_term_end_date;
    /** @type {string} */
    academic_program;
    /** @type {number} */
    total_term_payments;
    /** @type {number} */
    total_term_charges;
    /** @type {number} */
    total_term_taxes;
    /** @type {TermStatementRegistrationResponse[]} */
    registrations;
    /** @type {TermStatementChargesResponse[]} */
    charges;
}
export class TermStatementRequest {
    /** @param {{uuid?:string,reporting_term?:string,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    authorizing_uuid;
}

JavaScript TermStatementRequest 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 /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
		}
	]
}