| Required role: | REGISUserRole |
| 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<TermStatementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<authorizing_uuid>String</authorizing_uuid>
<reporting_term>String</reporting_term>
<uuid>String</uuid>
</TermStatementRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<TermStatementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<academic_program>String</academic_program>
<addr1>String</addr1>
<addr2>String</addr2>
<charges>
<TermStatementChargesResponse>
<charge>0</charge>
<code>String</code>
<date>0001-01-01T00:00:00</date>
<description>String</description>
<is_financial_aid>false</is_financial_aid>
</TermStatementChargesResponse>
</charges>
<city>String</city>
<code>String</code>
<country>String</country>
<name>String</name>
<regent_id>0</regent_id>
<registrations>
<TermStatementRegistrationResponse>
<amount>0</amount>
<cost>0</cost>
<course_name>String</course_name>
<end_date>0001-01-01T00:00:00</end_date>
<instructor>String</instructor>
<is_audit>false</is_audit>
<meeting_days>String</meeting_days>
<room>String</room>
<section_code>String</section_code>
<start_date>0001-01-01T00:00:00</start_date>
<status>String</status>
<times>String</times>
<title>String</title>
</TermStatementRegistrationResponse>
</registrations>
<reporting_term>String</reporting_term>
<reporting_term_end_date>0001-01-01T00:00:00</reporting_term_end_date>
<reporting_term_start_date>0001-01-01T00:00:00</reporting_term_start_date>
<state>String</state>
<total_term_charges>0</total_term_charges>
<total_term_payments>0</total_term_payments>
<total_term_taxes>0</total_term_taxes>
<uuid>String</uuid>
</TermStatementResponse>