regis

<back to all web services

FinancialAidSummaryInTermRequest

Requires Authentication
Required permission:FinancialAidPermission
The following routes are available for this service:
POST/Finance/FinancialAid/Awards/{reporting_term}/Summary
import java.math.*
import java.util.*
import net.servicestack.client.*


open class FinancialAidSummaryInTermRequest
{
    var reporting_term:String? = null
}

open class FinancialAidSummaryInTermResponse
{
    var responseStatus:ResponseStatus? = null
    var reporting_term:String? = null
    var awards:ArrayList<FinancialAidAwardSummaryInTermResponse> = ArrayList<FinancialAidAwardSummaryInTermResponse>()
}

open class FinancialAidAwardSummaryInTermResponse
{
    var award_id:Int? = null
    var award_code:String? = null
    var award_description:String? = null
    var budget_amount:BigDecimal? = null
    var awarded_amount:BigDecimal? = null
    var person_awards:ArrayList<FinancialAidAwardResponse> = ArrayList<FinancialAidAwardResponse>()
}

open class FinancialAidAwardResponse
{
    var uuid:String? = null
    var regent_id:Int? = null
    var first_name:String? = null
    var last_name:String? = null
    var awarded_amount:BigDecimal? = null
}

Kotlin FinancialAidSummaryInTermRequest 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 /Finance/FinancialAid/Awards/{reporting_term}/Summary HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"reporting_term":"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"}},"reporting_term":"String","awards":[{"award_id":0,"award_code":"String","award_description":"String","budget_amount":0,"awarded_amount":0,"person_awards":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","awarded_amount":0}]}]}