regis

<back to all web services

TermStatementRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/TermStatements/{uuid}/{reporting_term}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class TermStatementRequest
{
    var uuid:String? = null
    var reporting_term:String? = null
    var authorizing_uuid:String? = null
}

open class TermStatementResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var uuid:String? = null
    var name:String? = null
    var addr1:String? = null
    var addr2:String? = null
    var city:String? = null
    var state:String? = null
    var country:String? = null
    var code:String? = null
    var reporting_term:String? = null
    var reporting_term_start_date:Date? = null
    var reporting_term_end_date:Date? = null
    var academic_program:String? = null
    var total_term_payments:BigDecimal? = null
    var total_term_charges:BigDecimal? = null
    var total_term_taxes:BigDecimal? = null
    var registrations:ArrayList<TermStatementRegistrationResponse> = ArrayList<TermStatementRegistrationResponse>()
    var charges:ArrayList<TermStatementChargesResponse> = ArrayList<TermStatementChargesResponse>()
}

open class TermStatementRegistrationResponse
{
    var course_name:String? = null
    var title:String? = null
    var section_code:String? = null
    var amount:BigDecimal? = null
    var is_audit:Boolean? = null
    var meeting_days:String? = null
    var times:String? = null
    var room:String? = null
    var instructor:String? = null
    var status:String? = null
    var cost:BigDecimal? = null
    var start_date:Date? = null
    var end_date:Date? = null
}

open class TermStatementChargesResponse
{
    var date:Date? = null
    var code:String? = null
    var description:String? = null
    var is_financial_aid:Boolean? = null
    var charge:BigDecimal? = null
}

Kotlin TermStatementRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"uuid":"String","reporting_term":"String","authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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}]}