| Required role: | REGISUserRole |
| POST | /TermStatements/{uuid}/{reporting_term} |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;
namespace regis.ClassLibrary.Requests
{
public partial class TermStatementRequest
{
public virtual string uuid { get; set; }
public virtual string reporting_term { get; set; }
public virtual string authorizing_uuid { get; set; }
}
}
namespace regis.ClassLibrary.Responses
{
public partial class TermStatementChargesResponse
{
public virtual DateTime date { get; set; }
public virtual string code { get; set; }
public virtual string description { get; set; }
public virtual bool is_financial_aid { get; set; }
public virtual decimal charge { get; set; }
}
public partial class TermStatementRegistrationResponse
{
public virtual string course_name { get; set; }
public virtual string title { get; set; }
public virtual string section_code { get; set; }
public virtual decimal amount { get; set; }
public virtual bool is_audit { get; set; }
public virtual string meeting_days { get; set; }
public virtual string times { get; set; }
public virtual string room { get; set; }
public virtual string instructor { get; set; }
public virtual string status { get; set; }
public virtual decimal cost { get; set; }
public virtual DateTime? start_date { get; set; }
public virtual DateTime? end_date { get; set; }
}
public partial class TermStatementResponse
{
public TermStatementResponse()
{
registrations = new List<TermStatementRegistrationResponse>{};
charges = new List<TermStatementChargesResponse>{};
}
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual int regent_id { get; set; }
public virtual string uuid { get; set; }
public virtual string name { get; set; }
public virtual string addr1 { get; set; }
public virtual string addr2 { get; set; }
public virtual string city { get; set; }
public virtual string state { get; set; }
public virtual string country { get; set; }
public virtual string code { get; set; }
public virtual string reporting_term { get; set; }
public virtual DateTime reporting_term_start_date { get; set; }
public virtual DateTime reporting_term_end_date { get; set; }
public virtual string academic_program { get; set; }
public virtual decimal total_term_payments { get; set; }
public virtual decimal total_term_charges { get; set; }
public virtual decimal total_term_taxes { get; set; }
public virtual List<TermStatementRegistrationResponse> registrations { get; set; }
public virtual List<TermStatementChargesResponse> charges { 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>