regis

FinancialAidSummaryRequest

**Requires Authentication**
Required permission:	FinancialAidPermission

The following routes are available for this service:
POST	/Finance/FinancialAid/{uuid}/Summary

import Foundation
import ServiceStack

public class FinancialAidSummaryRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class FinancialAidSummaryResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var uuid:String
    public var applications:[FinancialAidApplicationResponse] = []
    public var awards:[FinancialAidApplicationAwardResponse] = []

    required public init(){}
}

public class FinancialAidApplicationResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var start_term:String
    public var end_term:String
    public var number_of_terms:Int?
    public var regent_id:Int
    public var uuid:String
    public var application_uuid:String
    public var awards:[FinancialAidApplicationAwardResponse] = []
    public var previous_awards:[FinancialAidApplicationAwardResponse] = []
    public var program:String
    public var gender:String
    public var first_name:String
    public var last_name:String
    public var email:String
    public var citizenship:String
    public var citizenship_other:String
    public var permanent_resident:String
    public var ethnicity:String
    public var marital_status:String
    public var dob:Date?
    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 denomination:String
    public var undergrad_gpa:Double?
    public var regent_gpa:Double?
    public var current_attempted_credits:Double?
    public var first_term_admitted:String
    public var current_attempted_and_transferred_credits:Double?
    public var current_award_term_attempted_credits:Double?
    public var number_of_children:Int?
    public var financial_assets:Double?
    public var spouse_income:Double?
    public var employment_years:Int?
    public var employment_description:String
    public var vocational_experience_json:String
    public var vocational_direction_json:String
    public var occupation_after_the_program_json:String
    public var area_of_study_json:String
    public var need_score:Int
    public var merit_score:Int
    public var score:Int
    public var is_mature:Bool
    public var is_nonaccredited:Bool
    public var award_per_term:Double?
    public var amount_awarded:Double?
    public var oncampus_tuition_owing_in_term:Double?
    public var online_tuition_owing_in_term:Double?
    public var audit_and_fees_owing_in_term:Double?
    public var amount_offered:Double?
    public var total_amount_awarded:Double?
    public var comments:String
    public var current_status:String
    public var cannot_apply_again:Bool
    public var current_status_date:Date?
    public var started_date:Date?
    public var started_by:String
    public var submitted_date:Date?
    public var submitted_by:String
    public var changed_date:Date?
    public var changed_by:String

    required public init(){}
}

public class FinancialAidApplicationAwardResponse : Codable
{
    public var id:Int
    public var award_code:String
    public var award_description:String
    public var is_awarded:Bool
    public var is_planned:Bool
    public var is_eligible:Bool
    public var award_amount:Double?
    public var award_budget:Double?
    public var comments:String
    public var term:String
    public var awarded_by:String
    public var awarded_date:Date?

    required public init(){}
}

Swift FinancialAidSummaryRequest 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/{uuid}/Summary HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinancialAidSummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <uuid>String</uuid>
</FinancialAidSummaryRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FinancialAidSummaryResponse 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>
  <applications>
    <FinancialAidApplicationResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1: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>
  </applications>
  <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>
  <uuid>String</uuid>
</FinancialAidSummaryResponse>