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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"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":0,"financial_assets":0,"spouse_income":0,"number_of_children":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","undergrad_gpa":0,"regent_gpa":0,"is_mature":false,"is_nonaccredited":false,"award_per_term":0,"amount_awarded":0,"need_score":0,"merit_score":0,"current_status":"String","comments":"String"}

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

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}