regis

TermStatementRequest

**Requires Authentication**
Required role:	REGISUserRole

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

namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TermStatementRegistrationResponse() = 
        member val course_name:String = null with get,set
        member val title:String = null with get,set
        member val section_code:String = null with get,set
        member val amount:Decimal = new Decimal() with get,set
        member val is_audit:Boolean = new Boolean() with get,set
        member val meeting_days:String = null with get,set
        member val times:String = null with get,set
        member val room:String = null with get,set
        member val instructor:String = null with get,set
        member val status:String = null with get,set
        member val cost:Decimal = new Decimal() with get,set
        member val start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type TermStatementChargesResponse() = 
        member val date:DateTime = new DateTime() with get,set
        member val code:String = null with get,set
        member val description:String = null with get,set
        member val is_financial_aid:Boolean = new Boolean() with get,set
        member val charge:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type TermStatementResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val name:String = null with get,set
        member val addr1:String = null with get,set
        member val addr2:String = null with get,set
        member val city:String = null with get,set
        member val state:String = null with get,set
        member val country:String = null with get,set
        member val code:String = null with get,set
        member val reporting_term:String = null with get,set
        member val reporting_term_start_date:DateTime = new DateTime() with get,set
        member val reporting_term_end_date:DateTime = new DateTime() with get,set
        member val academic_program:String = null with get,set
        member val total_term_payments:Decimal = new Decimal() with get,set
        member val total_term_charges:Decimal = new Decimal() with get,set
        member val total_term_taxes:Decimal = new Decimal() with get,set
        member val registrations:ResizeArray<TermStatementRegistrationResponse> = new ResizeArray<TermStatementRegistrationResponse>() with get,set
        member val charges:ResizeArray<TermStatementChargesResponse> = new ResizeArray<TermStatementChargesResponse>() with get,set

    [<AllowNullLiteral>]
    type TermStatementRequest() = 
        member val uuid:String = null with get,set
        member val reporting_term:String = null with get,set
        member val authorizing_uuid:String = null with get,set

F# 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
		}
	]
}