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.*;

public class dtos
{

    public static class FinancialAidSummaryInTermRequest
    {
        public String reporting_term = null;
        
        public String getReportingTerm() { return reporting_term; }
        public FinancialAidSummaryInTermRequest setReportingTerm(String value) { this.reporting_term = value; return this; }
    }

    public static class FinancialAidSummaryInTermResponse
    {
        public ResponseStatus responseStatus = null;
        public String reporting_term = null;
        public ArrayList<FinancialAidAwardSummaryInTermResponse> awards = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public FinancialAidSummaryInTermResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public FinancialAidSummaryInTermResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
        public ArrayList<FinancialAidAwardSummaryInTermResponse> getAwards() { return awards; }
        public FinancialAidSummaryInTermResponse setAwards(ArrayList<FinancialAidAwardSummaryInTermResponse> value) { this.awards = value; return this; }
    }

    public static class FinancialAidAwardSummaryInTermResponse
    {
        public Integer award_id = null;
        public String award_code = null;
        public String award_description = null;
        public BigDecimal budget_amount = null;
        public BigDecimal awarded_amount = null;
        public ArrayList<FinancialAidAwardResponse> person_awards = null;
        
        public Integer getAwardId() { return award_id; }
        public FinancialAidAwardSummaryInTermResponse setAwardId(Integer value) { this.award_id = value; return this; }
        public String getAwardCode() { return award_code; }
        public FinancialAidAwardSummaryInTermResponse setAwardCode(String value) { this.award_code = value; return this; }
        public String getAwardDescription() { return award_description; }
        public FinancialAidAwardSummaryInTermResponse setAwardDescription(String value) { this.award_description = value; return this; }
        public BigDecimal getBudgetAmount() { return budget_amount; }
        public FinancialAidAwardSummaryInTermResponse setBudgetAmount(BigDecimal value) { this.budget_amount = value; return this; }
        public BigDecimal getAwardedAmount() { return awarded_amount; }
        public FinancialAidAwardSummaryInTermResponse setAwardedAmount(BigDecimal value) { this.awarded_amount = value; return this; }
        public ArrayList<FinancialAidAwardResponse> getPersonAwards() { return person_awards; }
        public FinancialAidAwardSummaryInTermResponse setPersonAwards(ArrayList<FinancialAidAwardResponse> value) { this.person_awards = value; return this; }
    }

    public static class FinancialAidAwardResponse
    {
        public String uuid = null;
        public Integer regent_id = null;
        public String first_name = null;
        public String last_name = null;
        public BigDecimal awarded_amount = null;
        
        public String getUuid() { return uuid; }
        public FinancialAidAwardResponse setUuid(String value) { this.uuid = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public FinancialAidAwardResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getFirstName() { return first_name; }
        public FinancialAidAwardResponse setFirstName(String value) { this.first_name = value; return this; }
        public String getLastName() { return last_name; }
        public FinancialAidAwardResponse setLastName(String value) { this.last_name = value; return this; }
        public BigDecimal getAwardedAmount() { return awarded_amount; }
        public FinancialAidAwardResponse setAwardedAmount(BigDecimal value) { this.awarded_amount = value; return this; }
    }

}

Java FinancialAidSummaryInTermRequest DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"reporting_term":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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}]}]}