regis

FinancialAidApplicationsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Finance/FinancialAid/Applications


export class FinancialAidApplicationAwardResponse
{
    public id: number;
    public award_code: string;
    public award_description: string;
    public is_awarded: boolean;
    public is_planned: boolean;
    public is_eligible: boolean;
    public award_amount?: number;
    public award_budget?: number;
    public comments: string;
    public term: string;
    public awarded_by: string;
    public awarded_date?: string;

    public constructor(init?: Partial<FinancialAidApplicationAwardResponse>) { (Object as any).assign(this, init); }
}

export class FinancialAidApplicationResponse
{
    public responseStatus: ResponseStatus;
    public start_term: string;
    public end_term: string;
    public number_of_terms?: number;
    public regent_id: number;
    public uuid: string;
    public application_uuid: string;
    public awards: FinancialAidApplicationAwardResponse[];
    public previous_awards: FinancialAidApplicationAwardResponse[];
    public program: string;
    public gender: string;
    public first_name: string;
    public last_name: string;
    public email: string;
    public citizenship: string;
    public citizenship_other: string;
    public permanent_resident: string;
    public ethnicity: string;
    public marital_status: string;
    public dob?: string;
    public addr1: string;
    public addr2: string;
    public city: string;
    public state: string;
    public country: string;
    public code: string;
    public denomination: string;
    public undergrad_gpa?: number;
    public regent_gpa?: number;
    public current_attempted_credits?: number;
    public first_term_admitted: string;
    public current_attempted_and_transferred_credits?: number;
    public current_award_term_attempted_credits?: number;
    public number_of_children?: number;
    public financial_assets?: number;
    public spouse_income?: number;
    public employment_years?: number;
    public employment_description: string;
    public vocational_experience_json: string;
    public vocational_direction_json: string;
    public occupation_after_the_program_json: string;
    public area_of_study_json: string;
    public need_score: number;
    public merit_score: number;
    public score: number;
    public is_mature: boolean;
    public is_nonaccredited: boolean;
    public award_per_term?: number;
    public amount_awarded?: number;
    public oncampus_tuition_owing_in_term?: number;
    public online_tuition_owing_in_term?: number;
    public audit_and_fees_owing_in_term?: number;
    public amount_offered?: number;
    public total_amount_awarded?: number;
    public comments: string;
    public current_status: string;
    public cannot_apply_again: boolean;
    public current_status_date?: string;
    public started_date?: string;
    public started_by: string;
    public submitted_date?: string;
    public submitted_by: string;
    public changed_date?: string;
    public changed_by: string;

    public constructor(init?: Partial<FinancialAidApplicationResponse>) { (Object as any).assign(this, init); }
}

export class FinancialAidApplicationsResponse
{
    public responseStatus: ResponseStatus;
    public applications: FinancialAidApplicationResponse[];

    public constructor(init?: Partial<FinancialAidApplicationsResponse>) { (Object as any).assign(this, init); }
}

export class FinancialAidApplicationsRequest
{
    public start_term: string;
    public continuing_term: string;
    public issued_in_term: string;
    public available_in_term: string;
    public done_in_term: string;
    public no_awards_in_response: boolean;

    public constructor(init?: Partial<FinancialAidApplicationsRequest>) { (Object as any).assign(this, init); }
}

TypeScript FinancialAidApplicationsRequest 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/Applications HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinancialAidApplicationsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <available_in_term>String</available_in_term>
  <continuing_term>String</continuing_term>
  <done_in_term>String</done_in_term>
  <issued_in_term>String</issued_in_term>
  <no_awards_in_response>false</no_awards_in_response>
  <start_term>String</start_term>
</FinancialAidApplicationsRequest>

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

<FinancialAidApplicationsResponse 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>
</FinancialAidApplicationsResponse>