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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	application_uuid: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		},
		start_term: String,
		end_term: String,
		number_of_terms: 0,
		regent_id: 0,
		uuid: String,
		application_uuid: String,
		awards: 
		[
			{
				id: 0,
				award_code: String,
				award_description: String,
				is_awarded: False,
				is_planned: False,
				is_eligible: False,
				award_amount: 0,
				award_budget: 0,
				comments: String,
				term: String,
				awarded_by: String,
				awarded_date: 0001-01-01
			}
		],
		previous_awards: 
		[
			{
				id: 0,
				award_code: String,
				award_description: String,
				is_awarded: False,
				is_planned: False,
				is_eligible: False,
				award_amount: 0,
				award_budget: 0,
				comments: String,
				term: String,
				awarded_by: String,
				awarded_date: 0001-01-01
			}
		],
		program: String,
		gender: String,
		first_name: String,
		last_name: String,
		email: String,
		citizenship: String,
		citizenship_other: String,
		permanent_resident: String,
		ethnicity: String,
		marital_status: String,
		dob: 0001-01-01,
		addr1: String,
		addr2: String,
		city: String,
		state: String,
		country: String,
		code: String,
		denomination: String,
		undergrad_gpa: 0,
		regent_gpa: 0,
		current_attempted_credits: 0,
		first_term_admitted: String,
		current_attempted_and_transferred_credits: 0,
		current_award_term_attempted_credits: 0,
		number_of_children: 0,
		financial_assets: 0,
		spouse_income: 0,
		employment_years: 0,
		employment_description: String,
		vocational_experience_json: String,
		vocational_direction_json: String,
		occupation_after_the_program_json: String,
		area_of_study_json: String,
		need_score: 0,
		merit_score: 0,
		score: 0,
		is_mature: False,
		is_nonaccredited: False,
		award_per_term: 0,
		amount_awarded: 0,
		oncampus_tuition_owing_in_term: 0,
		online_tuition_owing_in_term: 0,
		audit_and_fees_owing_in_term: 0,
		amount_offered: 0,
		total_amount_awarded: 0,
		comments: String,
		current_status: String,
		cannot_apply_again: False,
		current_status_date: 0001-01-01,
		started_date: 0001-01-01,
		started_by: String,
		submitted_date: 0001-01-01,
		submitted_by: String,
		changed_date: 0001-01-01,
		changed_by: String
	}
]