regis

FinancialAidApplicationsRequest

**Requires Authentication**
Required role:	REGISUserRole

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class FinancialAidApplicationsRequest
    {
        public virtual string start_term { get; set; }
        public virtual string continuing_term { get; set; }
        public virtual string issued_in_term { get; set; }
        public virtual string available_in_term { get; set; }
        public virtual string done_in_term { get; set; }
        public virtual bool no_awards_in_response { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class FinancialAidApplicationAwardResponse
    {
        public virtual int id { get; set; }
        public virtual string award_code { get; set; }
        public virtual string award_description { get; set; }
        public virtual bool is_awarded { get; set; }
        public virtual bool is_planned { get; set; }
        public virtual bool is_eligible { get; set; }
        public virtual decimal? award_amount { get; set; }
        public virtual decimal? award_budget { get; set; }
        public virtual string comments { get; set; }
        public virtual string term { get; set; }
        public virtual string awarded_by { get; set; }
        public virtual DateTime? awarded_date { get; set; }
    }

    public partial class FinancialAidApplicationResponse
    {
        public FinancialAidApplicationResponse()
        {
            awards = new List<FinancialAidApplicationAwardResponse>{};
            previous_awards = new List<FinancialAidApplicationAwardResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string start_term { get; set; }
        public virtual string end_term { get; set; }
        public virtual int? number_of_terms { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string uuid { get; set; }
        public virtual string application_uuid { get; set; }
        public virtual List<FinancialAidApplicationAwardResponse> awards { get; set; }
        public virtual List<FinancialAidApplicationAwardResponse> previous_awards { get; set; }
        public virtual string program { get; set; }
        public virtual string gender { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string email { get; set; }
        public virtual string citizenship { get; set; }
        public virtual string citizenship_other { get; set; }
        public virtual string permanent_resident { get; set; }
        public virtual string ethnicity { get; set; }
        public virtual string marital_status { get; set; }
        public virtual DateTime? dob { get; set; }
        public virtual string addr1 { get; set; }
        public virtual string addr2 { get; set; }
        public virtual string city { get; set; }
        public virtual string state { get; set; }
        public virtual string country { get; set; }
        public virtual string code { get; set; }
        public virtual string denomination { get; set; }
        public virtual decimal? undergrad_gpa { get; set; }
        public virtual decimal? regent_gpa { get; set; }
        public virtual decimal? current_attempted_credits { get; set; }
        public virtual string first_term_admitted { get; set; }
        public virtual decimal? current_attempted_and_transferred_credits { get; set; }
        public virtual decimal? current_award_term_attempted_credits { get; set; }
        public virtual int? number_of_children { get; set; }
        public virtual decimal? financial_assets { get; set; }
        public virtual decimal? spouse_income { get; set; }
        public virtual int? employment_years { get; set; }
        public virtual string employment_description { get; set; }
        public virtual string vocational_experience_json { get; set; }
        public virtual string vocational_direction_json { get; set; }
        public virtual string occupation_after_the_program_json { get; set; }
        public virtual string area_of_study_json { get; set; }
        public virtual int need_score { get; set; }
        public virtual int merit_score { get; set; }
        public virtual int score { get; set; }
        public virtual bool is_mature { get; set; }
        public virtual bool is_nonaccredited { get; set; }
        public virtual decimal? award_per_term { get; set; }
        public virtual decimal? amount_awarded { get; set; }
        public virtual decimal? oncampus_tuition_owing_in_term { get; set; }
        public virtual decimal? online_tuition_owing_in_term { get; set; }
        public virtual decimal? audit_and_fees_owing_in_term { get; set; }
        public virtual decimal? amount_offered { get; set; }
        public virtual decimal? total_amount_awarded { get; set; }
        public virtual string comments { get; set; }
        public virtual string current_status { get; set; }
        public virtual bool cannot_apply_again { get; set; }
        public virtual DateTime? current_status_date { get; set; }
        public virtual DateTime? started_date { get; set; }
        public virtual string started_by { get; set; }
        public virtual DateTime? submitted_date { get; set; }
        public virtual string submitted_by { get; set; }
        public virtual DateTime? changed_date { get; set; }
        public virtual string changed_by { get; set; }
    }

    public partial class FinancialAidApplicationsResponse
    {
        public FinancialAidApplicationsResponse()
        {
            applications = new List<FinancialAidApplicationResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<FinancialAidApplicationResponse> applications { get; set; }
    }

}

C# 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>