regis

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

"use strict";
export class FinancialAidApplicationUpsertRequest {
    /** @param {{uuid?:string,application_uuid?:string,authorizing_uuid?:string,citizenship?:string,citizenship_other?:string,permanent_resident?:string,marital_status?:string,gender?:string,denomination?:string,ethnicity?:string,program?:string,start_term?:string,end_term?:string,number_of_terms?:number,financial_assets?:number,spouse_income?:number,number_of_children?:number,employment_years?:number,employment_description?:string,vocational_experience_json?:string,vocational_direction_json?:string,occupation_after_the_program_json?:string,area_of_study_json?:string,undergrad_gpa?:number,regent_gpa?:number,is_mature?:boolean,is_nonaccredited?:boolean,award_per_term?:number,amount_awarded?:number,need_score?:number,merit_score?:number,current_status?:string,comments?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    application_uuid;
    /** @type {string} */
    authorizing_uuid;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {string} */
    marital_status;
    /** @type {string} */
    gender;
    /** @type {string} */
    denomination;
    /** @type {string} */
    ethnicity;
    /** @type {string} */
    program;
    /** @type {string} */
    start_term;
    /** @type {string} */
    end_term;
    /** @type {?number} */
    number_of_terms;
    /** @type {?number} */
    financial_assets;
    /** @type {?number} */
    spouse_income;
    /** @type {?number} */
    number_of_children;
    /** @type {?number} */
    employment_years;
    /** @type {string} */
    employment_description;
    /** @type {string} */
    vocational_experience_json;
    /** @type {string} */
    vocational_direction_json;
    /** @type {string} */
    occupation_after_the_program_json;
    /** @type {string} */
    area_of_study_json;
    /** @type {?number} */
    undergrad_gpa;
    /** @type {?number} */
    regent_gpa;
    /** @type {boolean} */
    is_mature;
    /** @type {boolean} */
    is_nonaccredited;
    /** @type {?number} */
    award_per_term;
    /** @type {?number} */
    amount_awarded;
    /** @type {number} */
    need_score;
    /** @type {number} */
    merit_score;
    /** @type {string} */
    current_status;
    /** @type {string} */
    comments;
}

JavaScript 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>