regis

<back to all web services

FinancialAidApplicationRequest

Requires Authentication
Required permission:FinancialAidPermission
The following routes are available for this service:
POST/Finance/FinancialAid/Application/{application_uuid}/Get
POST/Finance/FinancialAid/{uuid}/Application/{start_term}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class FinancialAidApplicationRequest
    {
        public String uuid = null;
        public String start_term = null;
        public String application_uuid = null;
        public String awards_in_term = null;
        public Boolean no_awards_in_response = null;
        
        public String getUuid() { return uuid; }
        public FinancialAidApplicationRequest setUuid(String value) { this.uuid = value; return this; }
        public String getStartTerm() { return start_term; }
        public FinancialAidApplicationRequest setStartTerm(String value) { this.start_term = value; return this; }
        public String getApplicationUuid() { return application_uuid; }
        public FinancialAidApplicationRequest setApplicationUuid(String value) { this.application_uuid = value; return this; }
        public String getAwardsInTerm() { return awards_in_term; }
        public FinancialAidApplicationRequest setAwardsInTerm(String value) { this.awards_in_term = value; return this; }
        public Boolean isNoAwardsInResponse() { return no_awards_in_response; }
        public FinancialAidApplicationRequest setNoAwardsInResponse(Boolean value) { this.no_awards_in_response = value; return this; }
    }

    public static class FinancialAidApplicationResponse
    {
        public ResponseStatus responseStatus = null;
        public String start_term = null;
        public String end_term = null;
        public Integer number_of_terms = null;
        public Integer regent_id = null;
        public String uuid = null;
        public String application_uuid = null;
        public ArrayList<FinancialAidApplicationAwardResponse> awards = null;
        public ArrayList<FinancialAidApplicationAwardResponse> previous_awards = null;
        public String program = null;
        public String gender = null;
        public String first_name = null;
        public String last_name = null;
        public String email = null;
        public String citizenship = null;
        public String citizenship_other = null;
        public String permanent_resident = null;
        public String ethnicity = null;
        public String marital_status = null;
        public Date dob = null;
        public String addr1 = null;
        public String addr2 = null;
        public String city = null;
        public String state = null;
        public String country = null;
        public String code = null;
        public String denomination = null;
        public BigDecimal undergrad_gpa = null;
        public BigDecimal regent_gpa = null;
        public BigDecimal current_attempted_credits = null;
        public String first_term_admitted = null;
        public BigDecimal current_attempted_and_transferred_credits = null;
        public BigDecimal current_award_term_attempted_credits = null;
        public Integer number_of_children = null;
        public BigDecimal financial_assets = null;
        public BigDecimal spouse_income = null;
        public Integer employment_years = null;
        public String employment_description = null;
        public String vocational_experience_json = null;
        public String vocational_direction_json = null;
        public String occupation_after_the_program_json = null;
        public String area_of_study_json = null;
        public Integer need_score = null;
        public Integer merit_score = null;
        public Integer score = null;
        public Boolean is_mature = null;
        public Boolean is_nonaccredited = null;
        public BigDecimal award_per_term = null;
        public BigDecimal amount_awarded = null;
        public BigDecimal oncampus_tuition_owing_in_term = null;
        public BigDecimal online_tuition_owing_in_term = null;
        public BigDecimal audit_and_fees_owing_in_term = null;
        public BigDecimal amount_offered = null;
        public BigDecimal total_amount_awarded = null;
        public String comments = null;
        public String current_status = null;
        public Boolean cannot_apply_again = null;
        public Date current_status_date = null;
        public Date started_date = null;
        public String started_by = null;
        public Date submitted_date = null;
        public String submitted_by = null;
        public Date changed_date = null;
        public String changed_by = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public FinancialAidApplicationResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getStartTerm() { return start_term; }
        public FinancialAidApplicationResponse setStartTerm(String value) { this.start_term = value; return this; }
        public String getEndTerm() { return end_term; }
        public FinancialAidApplicationResponse setEndTerm(String value) { this.end_term = value; return this; }
        public Integer getNumberOfTerms() { return number_of_terms; }
        public FinancialAidApplicationResponse setNumberOfTerms(Integer value) { this.number_of_terms = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public FinancialAidApplicationResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getUuid() { return uuid; }
        public FinancialAidApplicationResponse setUuid(String value) { this.uuid = value; return this; }
        public String getApplicationUuid() { return application_uuid; }
        public FinancialAidApplicationResponse setApplicationUuid(String value) { this.application_uuid = value; return this; }
        public ArrayList<FinancialAidApplicationAwardResponse> getAwards() { return awards; }
        public FinancialAidApplicationResponse setAwards(ArrayList<FinancialAidApplicationAwardResponse> value) { this.awards = value; return this; }
        public ArrayList<FinancialAidApplicationAwardResponse> getPreviousAwards() { return previous_awards; }
        public FinancialAidApplicationResponse setPreviousAwards(ArrayList<FinancialAidApplicationAwardResponse> value) { this.previous_awards = value; return this; }
        public String getProgram() { return program; }
        public FinancialAidApplicationResponse setProgram(String value) { this.program = value; return this; }
        public String getGender() { return gender; }
        public FinancialAidApplicationResponse setGender(String value) { this.gender = value; return this; }
        public String getFirstName() { return first_name; }
        public FinancialAidApplicationResponse setFirstName(String value) { this.first_name = value; return this; }
        public String getLastName() { return last_name; }
        public FinancialAidApplicationResponse setLastName(String value) { this.last_name = value; return this; }
        public String getEmail() { return email; }
        public FinancialAidApplicationResponse setEmail(String value) { this.email = value; return this; }
        public String getCitizenship() { return citizenship; }
        public FinancialAidApplicationResponse setCitizenship(String value) { this.citizenship = value; return this; }
        public String getCitizenshipOther() { return citizenship_other; }
        public FinancialAidApplicationResponse setCitizenshipOther(String value) { this.citizenship_other = value; return this; }
        public String getPermanentResident() { return permanent_resident; }
        public FinancialAidApplicationResponse setPermanentResident(String value) { this.permanent_resident = value; return this; }
        public String getEthnicity() { return ethnicity; }
        public FinancialAidApplicationResponse setEthnicity(String value) { this.ethnicity = value; return this; }
        public String getMaritalStatus() { return marital_status; }
        public FinancialAidApplicationResponse setMaritalStatus(String value) { this.marital_status = value; return this; }
        public Date getDob() { return dob; }
        public FinancialAidApplicationResponse setDob(Date value) { this.dob = value; return this; }
        public String getAddr1() { return addr1; }
        public FinancialAidApplicationResponse setAddr1(String value) { this.addr1 = value; return this; }
        public String getAddr2() { return addr2; }
        public FinancialAidApplicationResponse setAddr2(String value) { this.addr2 = value; return this; }
        public String getCity() { return city; }
        public FinancialAidApplicationResponse setCity(String value) { this.city = value; return this; }
        public String getState() { return state; }
        public FinancialAidApplicationResponse setState(String value) { this.state = value; return this; }
        public String getCountry() { return country; }
        public FinancialAidApplicationResponse setCountry(String value) { this.country = value; return this; }
        public String getCode() { return code; }
        public FinancialAidApplicationResponse setCode(String value) { this.code = value; return this; }
        public String getDenomination() { return denomination; }
        public FinancialAidApplicationResponse setDenomination(String value) { this.denomination = value; return this; }
        public BigDecimal getUndergradGpa() { return undergrad_gpa; }
        public FinancialAidApplicationResponse setUndergradGpa(BigDecimal value) { this.undergrad_gpa = value; return this; }
        public BigDecimal getRegentGpa() { return regent_gpa; }
        public FinancialAidApplicationResponse setRegentGpa(BigDecimal value) { this.regent_gpa = value; return this; }
        public BigDecimal getCurrentAttemptedCredits() { return current_attempted_credits; }
        public FinancialAidApplicationResponse setCurrentAttemptedCredits(BigDecimal value) { this.current_attempted_credits = value; return this; }
        public String getFirstTermAdmitted() { return first_term_admitted; }
        public FinancialAidApplicationResponse setFirstTermAdmitted(String value) { this.first_term_admitted = value; return this; }
        public BigDecimal getCurrentAttemptedAndTransferredCredits() { return current_attempted_and_transferred_credits; }
        public FinancialAidApplicationResponse setCurrentAttemptedAndTransferredCredits(BigDecimal value) { this.current_attempted_and_transferred_credits = value; return this; }
        public BigDecimal getCurrentAwardTermAttemptedCredits() { return current_award_term_attempted_credits; }
        public FinancialAidApplicationResponse setCurrentAwardTermAttemptedCredits(BigDecimal value) { this.current_award_term_attempted_credits = value; return this; }
        public Integer getNumberOfChildren() { return number_of_children; }
        public FinancialAidApplicationResponse setNumberOfChildren(Integer value) { this.number_of_children = value; return this; }
        public BigDecimal getFinancialAssets() { return financial_assets; }
        public FinancialAidApplicationResponse setFinancialAssets(BigDecimal value) { this.financial_assets = value; return this; }
        public BigDecimal getSpouseIncome() { return spouse_income; }
        public FinancialAidApplicationResponse setSpouseIncome(BigDecimal value) { this.spouse_income = value; return this; }
        public Integer getEmploymentYears() { return employment_years; }
        public FinancialAidApplicationResponse setEmploymentYears(Integer value) { this.employment_years = value; return this; }
        public String getEmploymentDescription() { return employment_description; }
        public FinancialAidApplicationResponse setEmploymentDescription(String value) { this.employment_description = value; return this; }
        public String getVocationalExperienceJson() { return vocational_experience_json; }
        public FinancialAidApplicationResponse setVocationalExperienceJson(String value) { this.vocational_experience_json = value; return this; }
        public String getVocationalDirectionJson() { return vocational_direction_json; }
        public FinancialAidApplicationResponse setVocationalDirectionJson(String value) { this.vocational_direction_json = value; return this; }
        public String getOccupationAfterTheProgramJson() { return occupation_after_the_program_json; }
        public FinancialAidApplicationResponse setOccupationAfterTheProgramJson(String value) { this.occupation_after_the_program_json = value; return this; }
        public String getAreaOfStudyJson() { return area_of_study_json; }
        public FinancialAidApplicationResponse setAreaOfStudyJson(String value) { this.area_of_study_json = value; return this; }
        public Integer getNeedScore() { return need_score; }
        public FinancialAidApplicationResponse setNeedScore(Integer value) { this.need_score = value; return this; }
        public Integer getMeritScore() { return merit_score; }
        public FinancialAidApplicationResponse setMeritScore(Integer value) { this.merit_score = value; return this; }
        public Integer getScore() { return score; }
        public FinancialAidApplicationResponse setScore(Integer value) { this.score = value; return this; }
        public Boolean getIsMature() { return is_mature; }
        public FinancialAidApplicationResponse setIsMature(Boolean value) { this.is_mature = value; return this; }
        public Boolean getIsNonaccredited() { return is_nonaccredited; }
        public FinancialAidApplicationResponse setIsNonaccredited(Boolean value) { this.is_nonaccredited = value; return this; }
        public BigDecimal getAwardPerTerm() { return award_per_term; }
        public FinancialAidApplicationResponse setAwardPerTerm(BigDecimal value) { this.award_per_term = value; return this; }
        public BigDecimal getAmountAwarded() { return amount_awarded; }
        public FinancialAidApplicationResponse setAmountAwarded(BigDecimal value) { this.amount_awarded = value; return this; }
        public BigDecimal getOncampusTuitionOwingInTerm() { return oncampus_tuition_owing_in_term; }
        public FinancialAidApplicationResponse setOncampusTuitionOwingInTerm(BigDecimal value) { this.oncampus_tuition_owing_in_term = value; return this; }
        public BigDecimal getOnlineTuitionOwingInTerm() { return online_tuition_owing_in_term; }
        public FinancialAidApplicationResponse setOnlineTuitionOwingInTerm(BigDecimal value) { this.online_tuition_owing_in_term = value; return this; }
        public BigDecimal getAuditAndFeesOwingInTerm() { return audit_and_fees_owing_in_term; }
        public FinancialAidApplicationResponse setAuditAndFeesOwingInTerm(BigDecimal value) { this.audit_and_fees_owing_in_term = value; return this; }
        public BigDecimal getAmountOffered() { return amount_offered; }
        public FinancialAidApplicationResponse setAmountOffered(BigDecimal value) { this.amount_offered = value; return this; }
        public BigDecimal getTotalAmountAwarded() { return total_amount_awarded; }
        public FinancialAidApplicationResponse setTotalAmountAwarded(BigDecimal value) { this.total_amount_awarded = value; return this; }
        public String getComments() { return comments; }
        public FinancialAidApplicationResponse setComments(String value) { this.comments = value; return this; }
        public String getCurrentStatus() { return current_status; }
        public FinancialAidApplicationResponse setCurrentStatus(String value) { this.current_status = value; return this; }
        public Boolean isCannotApplyAgain() { return cannot_apply_again; }
        public FinancialAidApplicationResponse setCannotApplyAgain(Boolean value) { this.cannot_apply_again = value; return this; }
        public Date getCurrentStatusDate() { return current_status_date; }
        public FinancialAidApplicationResponse setCurrentStatusDate(Date value) { this.current_status_date = value; return this; }
        public Date getStartedDate() { return started_date; }
        public FinancialAidApplicationResponse setStartedDate(Date value) { this.started_date = value; return this; }
        public String getStartedBy() { return started_by; }
        public FinancialAidApplicationResponse setStartedBy(String value) { this.started_by = value; return this; }
        public Date getSubmittedDate() { return submitted_date; }
        public FinancialAidApplicationResponse setSubmittedDate(Date value) { this.submitted_date = value; return this; }
        public String getSubmittedBy() { return submitted_by; }
        public FinancialAidApplicationResponse setSubmittedBy(String value) { this.submitted_by = value; return this; }
        public Date getChangedDate() { return changed_date; }
        public FinancialAidApplicationResponse setChangedDate(Date value) { this.changed_date = value; return this; }
        public String getChangedBy() { return changed_by; }
        public FinancialAidApplicationResponse setChangedBy(String value) { this.changed_by = value; return this; }
    }

    public static class FinancialAidApplicationAwardResponse
    {
        public Integer id = null;
        public String award_code = null;
        public String award_description = null;
        public Boolean is_awarded = null;
        public Boolean is_planned = null;
        public Boolean is_eligible = null;
        public BigDecimal award_amount = null;
        public BigDecimal award_budget = null;
        public String comments = null;
        public String term = null;
        public String awarded_by = null;
        public Date awarded_date = null;
        
        public Integer getId() { return id; }
        public FinancialAidApplicationAwardResponse setId(Integer value) { this.id = value; return this; }
        public String getAwardCode() { return award_code; }
        public FinancialAidApplicationAwardResponse setAwardCode(String value) { this.award_code = value; return this; }
        public String getAwardDescription() { return award_description; }
        public FinancialAidApplicationAwardResponse setAwardDescription(String value) { this.award_description = value; return this; }
        public Boolean getIsAwarded() { return is_awarded; }
        public FinancialAidApplicationAwardResponse setIsAwarded(Boolean value) { this.is_awarded = value; return this; }
        public Boolean getIsPlanned() { return is_planned; }
        public FinancialAidApplicationAwardResponse setIsPlanned(Boolean value) { this.is_planned = value; return this; }
        public Boolean getIsEligible() { return is_eligible; }
        public FinancialAidApplicationAwardResponse setIsEligible(Boolean value) { this.is_eligible = value; return this; }
        public BigDecimal getAwardAmount() { return award_amount; }
        public FinancialAidApplicationAwardResponse setAwardAmount(BigDecimal value) { this.award_amount = value; return this; }
        public BigDecimal getAwardBudget() { return award_budget; }
        public FinancialAidApplicationAwardResponse setAwardBudget(BigDecimal value) { this.award_budget = value; return this; }
        public String getComments() { return comments; }
        public FinancialAidApplicationAwardResponse setComments(String value) { this.comments = value; return this; }
        public String getTerm() { return term; }
        public FinancialAidApplicationAwardResponse setTerm(String value) { this.term = value; return this; }
        public String getAwardedBy() { return awarded_by; }
        public FinancialAidApplicationAwardResponse setAwardedBy(String value) { this.awarded_by = value; return this; }
        public Date getAwardedDate() { return awarded_date; }
        public FinancialAidApplicationAwardResponse setAwardedDate(Date value) { this.awarded_date = value; return this; }
    }

}

Java FinancialAidApplicationRequest DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Finance/FinancialAid/Application/{application_uuid}/Get HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinancialAidApplicationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <application_uuid>String</application_uuid>
  <awards_in_term>String</awards_in_term>
  <no_awards_in_response>false</no_awards_in_response>
  <start_term>String</start_term>
  <uuid>String</uuid>
</FinancialAidApplicationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FinancialAidApplicationResponse 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>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <amount_awarded>0</amount_awarded>
  <amount_offered>0</amount_offered>
  <application_uuid>String</application_uuid>
  <area_of_study_json>String</area_of_study_json>
  <audit_and_fees_owing_in_term>0</audit_and_fees_owing_in_term>
  <award_per_term>0</award_per_term>
  <awards>
    <FinancialAidApplicationAwardResponse>
      <award_amount>0</award_amount>
      <award_budget>0</award_budget>
      <award_code>String</award_code>
      <award_description>String</award_description>
      <awarded_by>String</awarded_by>
      <awarded_date>0001-01-01T00:00:00</awarded_date>
      <comments>String</comments>
      <id>0</id>
      <is_awarded>false</is_awarded>
      <is_eligible>false</is_eligible>
      <is_planned>false</is_planned>
      <term>String</term>
    </FinancialAidApplicationAwardResponse>
  </awards>
  <cannot_apply_again>false</cannot_apply_again>
  <changed_by>String</changed_by>
  <changed_date>0001-01-01T00:00:00</changed_date>
  <citizenship>String</citizenship>
  <citizenship_other>String</citizenship_other>
  <city>String</city>
  <code>String</code>
  <comments>String</comments>
  <country>String</country>
  <current_attempted_and_transferred_credits>0</current_attempted_and_transferred_credits>
  <current_attempted_credits>0</current_attempted_credits>
  <current_award_term_attempted_credits>0</current_award_term_attempted_credits>
  <current_status>String</current_status>
  <current_status_date>0001-01-01T00:00:00</current_status_date>
  <denomination>String</denomination>
  <dob>0001-01-01T00:00:00</dob>
  <email>String</email>
  <employment_description>String</employment_description>
  <employment_years>0</employment_years>
  <end_term>String</end_term>
  <ethnicity>String</ethnicity>
  <financial_assets>0</financial_assets>
  <first_name>String</first_name>
  <first_term_admitted>String</first_term_admitted>
  <gender>String</gender>
  <is_mature>false</is_mature>
  <is_nonaccredited>false</is_nonaccredited>
  <last_name>String</last_name>
  <marital_status>String</marital_status>
  <merit_score>0</merit_score>
  <need_score>0</need_score>
  <number_of_children>0</number_of_children>
  <number_of_terms>0</number_of_terms>
  <occupation_after_the_program_json>String</occupation_after_the_program_json>
  <oncampus_tuition_owing_in_term>0</oncampus_tuition_owing_in_term>
  <online_tuition_owing_in_term>0</online_tuition_owing_in_term>
  <permanent_resident>String</permanent_resident>
  <previous_awards>
    <FinancialAidApplicationAwardResponse>
      <award_amount>0</award_amount>
      <award_budget>0</award_budget>
      <award_code>String</award_code>
      <award_description>String</award_description>
      <awarded_by>String</awarded_by>
      <awarded_date>0001-01-01T00:00:00</awarded_date>
      <comments>String</comments>
      <id>0</id>
      <is_awarded>false</is_awarded>
      <is_eligible>false</is_eligible>
      <is_planned>false</is_planned>
      <term>String</term>
    </FinancialAidApplicationAwardResponse>
  </previous_awards>
  <program>String</program>
  <regent_gpa>0</regent_gpa>
  <regent_id>0</regent_id>
  <score>0</score>
  <spouse_income>0</spouse_income>
  <start_term>String</start_term>
  <started_by>String</started_by>
  <started_date>0001-01-01T00:00:00</started_date>
  <state>String</state>
  <submitted_by>String</submitted_by>
  <submitted_date>0001-01-01T00:00:00</submitted_date>
  <total_amount_awarded>0</total_amount_awarded>
  <undergrad_gpa>0</undergrad_gpa>
  <uuid>String</uuid>
  <vocational_direction_json>String</vocational_direction_json>
  <vocational_experience_json>String</vocational_experience_json>
</FinancialAidApplicationResponse>