Required role: | REGISUserRole |
POST | /TermStatements/{uuid}/{reporting_term} |
---|
import Foundation
import ServiceStack
public class TermStatementRequest : Codable
{
public var uuid:String
public var reporting_term:String
public var authorizing_uuid:String
required public init(){}
}
public class TermStatementResponse : Codable
{
public var responseStatus:ResponseStatus
public var regent_id:Int
public var uuid:String
public var name:String
public var addr1:String
public var addr2:String
public var city:String
public var state:String
public var country:String
public var code:String
public var reporting_term:String
public var reporting_term_start_date:Date
public var reporting_term_end_date:Date
public var academic_program:String
public var total_term_payments:Double
public var total_term_charges:Double
public var total_term_taxes:Double
public var registrations:[TermStatementRegistrationResponse] = []
public var charges:[TermStatementChargesResponse] = []
required public init(){}
}
public class TermStatementRegistrationResponse : Codable
{
public var course_name:String
public var title:String
public var section_code:String
public var amount:Double
public var is_audit:Bool
public var meeting_days:String
public var times:String
public var room:String
public var instructor:String
public var status:String
public var cost:Double
public var start_date:Date?
public var end_date:Date?
required public init(){}
}
public class TermStatementChargesResponse : Codable
{
public var date:Date
public var code:String
public var Description:String
public var is_financial_aid:Bool
public var charge:Double
required public init(){}
}
Swift TermStatementRequest DTOs
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>