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 .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"uuid":"String","reporting_term":"String","authorizing_uuid":"String"}
HTTP/1.1 200 OK Content-Type: text/jsonl 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-01T00:00:00.0000000","reporting_term_end_date":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000"}],"charges":[{"date":"0001-01-01T00:00:00.0000000","code":"String","description":"String","is_financial_aid":false,"charge":0}]}