regis

<back to all web services

FinancialAidApplicationUpsertRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/FinancialAid/Application/Upsert/New
POST/Finance/FinancialAid/Application/{application_uuid}/Upsert
<?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 FinancialAidApplicationUpsertRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $application_uuid=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null,
        /** @var string|null */
        public ?string $citizenship=null,
        /** @var string|null */
        public ?string $citizenship_other=null,
        /** @var string|null */
        public ?string $permanent_resident=null,
        /** @var string|null */
        public ?string $marital_status=null,
        /** @var string|null */
        public ?string $gender=null,
        /** @var string|null */
        public ?string $denomination=null,
        /** @var string|null */
        public ?string $ethnicity=null,
        /** @var string|null */
        public ?string $program=null,
        /** @var string|null */
        public ?string $start_term=null,
        /** @var string|null */
        public ?string $end_term=null,
        /** @var int|null */
        public ?int $number_of_terms=null,
        /** @var float|null */
        public ?float $financial_assets=null,
        /** @var float|null */
        public ?float $spouse_income=null,
        /** @var int|null */
        public ?int $number_of_children=null,
        /** @var int|null */
        public ?int $employment_years=null,
        /** @var string|null */
        public ?string $employment_description=null,
        /** @var string|null */
        public ?string $vocational_experience_json=null,
        /** @var string|null */
        public ?string $vocational_direction_json=null,
        /** @var string|null */
        public ?string $occupation_after_the_program_json=null,
        /** @var string|null */
        public ?string $area_of_study_json=null,
        /** @var float|null */
        public ?float $undergrad_gpa=null,
        /** @var float|null */
        public ?float $regent_gpa=null,
        /** @var bool|null */
        public ?bool $is_mature=null,
        /** @var bool|null */
        public ?bool $is_nonaccredited=null,
        /** @var float|null */
        public ?float $award_per_term=null,
        /** @var float|null */
        public ?float $amount_awarded=null,
        /** @var int */
        public int $need_score=0,
        /** @var int */
        public int $merit_score=0,
        /** @var string|null */
        public ?string $current_status=null,
        /** @var string|null */
        public ?string $comments=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['application_uuid'])) $this->application_uuid = $o['application_uuid'];
        if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
        if (isset($o['citizenship'])) $this->citizenship = $o['citizenship'];
        if (isset($o['citizenship_other'])) $this->citizenship_other = $o['citizenship_other'];
        if (isset($o['permanent_resident'])) $this->permanent_resident = $o['permanent_resident'];
        if (isset($o['marital_status'])) $this->marital_status = $o['marital_status'];
        if (isset($o['gender'])) $this->gender = $o['gender'];
        if (isset($o['denomination'])) $this->denomination = $o['denomination'];
        if (isset($o['ethnicity'])) $this->ethnicity = $o['ethnicity'];
        if (isset($o['program'])) $this->program = $o['program'];
        if (isset($o['start_term'])) $this->start_term = $o['start_term'];
        if (isset($o['end_term'])) $this->end_term = $o['end_term'];
        if (isset($o['number_of_terms'])) $this->number_of_terms = $o['number_of_terms'];
        if (isset($o['financial_assets'])) $this->financial_assets = $o['financial_assets'];
        if (isset($o['spouse_income'])) $this->spouse_income = $o['spouse_income'];
        if (isset($o['number_of_children'])) $this->number_of_children = $o['number_of_children'];
        if (isset($o['employment_years'])) $this->employment_years = $o['employment_years'];
        if (isset($o['employment_description'])) $this->employment_description = $o['employment_description'];
        if (isset($o['vocational_experience_json'])) $this->vocational_experience_json = $o['vocational_experience_json'];
        if (isset($o['vocational_direction_json'])) $this->vocational_direction_json = $o['vocational_direction_json'];
        if (isset($o['occupation_after_the_program_json'])) $this->occupation_after_the_program_json = $o['occupation_after_the_program_json'];
        if (isset($o['area_of_study_json'])) $this->area_of_study_json = $o['area_of_study_json'];
        if (isset($o['undergrad_gpa'])) $this->undergrad_gpa = $o['undergrad_gpa'];
        if (isset($o['regent_gpa'])) $this->regent_gpa = $o['regent_gpa'];
        if (isset($o['is_mature'])) $this->is_mature = $o['is_mature'];
        if (isset($o['is_nonaccredited'])) $this->is_nonaccredited = $o['is_nonaccredited'];
        if (isset($o['award_per_term'])) $this->award_per_term = $o['award_per_term'];
        if (isset($o['amount_awarded'])) $this->amount_awarded = $o['amount_awarded'];
        if (isset($o['need_score'])) $this->need_score = $o['need_score'];
        if (isset($o['merit_score'])) $this->merit_score = $o['merit_score'];
        if (isset($o['current_status'])) $this->current_status = $o['current_status'];
        if (isset($o['comments'])) $this->comments = $o['comments'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->application_uuid)) $o['application_uuid'] = $this->application_uuid;
        if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
        if (isset($this->citizenship)) $o['citizenship'] = $this->citizenship;
        if (isset($this->citizenship_other)) $o['citizenship_other'] = $this->citizenship_other;
        if (isset($this->permanent_resident)) $o['permanent_resident'] = $this->permanent_resident;
        if (isset($this->marital_status)) $o['marital_status'] = $this->marital_status;
        if (isset($this->gender)) $o['gender'] = $this->gender;
        if (isset($this->denomination)) $o['denomination'] = $this->denomination;
        if (isset($this->ethnicity)) $o['ethnicity'] = $this->ethnicity;
        if (isset($this->program)) $o['program'] = $this->program;
        if (isset($this->start_term)) $o['start_term'] = $this->start_term;
        if (isset($this->end_term)) $o['end_term'] = $this->end_term;
        if (isset($this->number_of_terms)) $o['number_of_terms'] = $this->number_of_terms;
        if (isset($this->financial_assets)) $o['financial_assets'] = $this->financial_assets;
        if (isset($this->spouse_income)) $o['spouse_income'] = $this->spouse_income;
        if (isset($this->number_of_children)) $o['number_of_children'] = $this->number_of_children;
        if (isset($this->employment_years)) $o['employment_years'] = $this->employment_years;
        if (isset($this->employment_description)) $o['employment_description'] = $this->employment_description;
        if (isset($this->vocational_experience_json)) $o['vocational_experience_json'] = $this->vocational_experience_json;
        if (isset($this->vocational_direction_json)) $o['vocational_direction_json'] = $this->vocational_direction_json;
        if (isset($this->occupation_after_the_program_json)) $o['occupation_after_the_program_json'] = $this->occupation_after_the_program_json;
        if (isset($this->area_of_study_json)) $o['area_of_study_json'] = $this->area_of_study_json;
        if (isset($this->undergrad_gpa)) $o['undergrad_gpa'] = $this->undergrad_gpa;
        if (isset($this->regent_gpa)) $o['regent_gpa'] = $this->regent_gpa;
        if (isset($this->is_mature)) $o['is_mature'] = $this->is_mature;
        if (isset($this->is_nonaccredited)) $o['is_nonaccredited'] = $this->is_nonaccredited;
        if (isset($this->award_per_term)) $o['award_per_term'] = $this->award_per_term;
        if (isset($this->amount_awarded)) $o['amount_awarded'] = $this->amount_awarded;
        if (isset($this->need_score)) $o['need_score'] = $this->need_score;
        if (isset($this->merit_score)) $o['merit_score'] = $this->merit_score;
        if (isset($this->current_status)) $o['current_status'] = $this->current_status;
        if (isset($this->comments)) $o['comments'] = $this->comments;
        return empty($o) ? new class(){} : $o;
    }
}

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

<FinancialAidApplicationUpsertRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <amount_awarded>0</amount_awarded>
  <application_uuid>String</application_uuid>
  <area_of_study_json>String</area_of_study_json>
  <authorizing_uuid>String</authorizing_uuid>
  <award_per_term>0</award_per_term>
  <citizenship>String</citizenship>
  <citizenship_other>String</citizenship_other>
  <comments>String</comments>
  <current_status>String</current_status>
  <denomination>String</denomination>
  <employment_description>String</employment_description>
  <employment_years>0</employment_years>
  <end_term>String</end_term>
  <ethnicity>String</ethnicity>
  <financial_assets>0</financial_assets>
  <gender>String</gender>
  <is_mature>false</is_mature>
  <is_nonaccredited>false</is_nonaccredited>
  <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>
  <permanent_resident>String</permanent_resident>
  <program>String</program>
  <regent_gpa>0</regent_gpa>
  <spouse_income>0</spouse_income>
  <start_term>String</start_term>
  <undergrad_gpa>0</undergrad_gpa>
  <uuid>String</uuid>
  <vocational_direction_json>String</vocational_direction_json>
  <vocational_experience_json>String</vocational_experience_json>
</FinancialAidApplicationUpsertRequest>

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

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <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>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>