regis

FinancialAidApplicationHistoryRequest

**Requires Authentication**
Required permission:	FinancialAidPermission

The following routes are available for this service:
POST	/Finance/FinancialAid/Application/{application_uuid}/History

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class FinancialAidApplicationHistoryRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $application_uuid=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['application_uuid'])) $this->application_uuid = $o['application_uuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->application_uuid)) $o['application_uuid'] = $this->application_uuid;
        return empty($o) ? new class(){} : $o;
    }
}

PHP FinancialAidApplicationHistoryRequest 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}/History HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<ArrayOfFinancialAidApplicationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <FinancialAidApplicationResponse>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1: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>
</ArrayOfFinancialAidApplicationResponse>