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
import 'package:servicestack/servicestack.dart';

class FinancialAidApplicationUpsertRequest implements IConvertible
{
    String? 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;
    int? number_of_terms;
    double? financial_assets;
    double? spouse_income;
    int? number_of_children;
    int? employment_years;
    String? employment_description;
    String? vocational_experience_json;
    String? vocational_direction_json;
    String? occupation_after_the_program_json;
    String? area_of_study_json;
    double? undergrad_gpa;
    double? regent_gpa;
    bool? is_mature;
    bool? is_nonaccredited;
    double? award_per_term;
    double? amount_awarded;
    int? need_score;
    int? merit_score;
    String? current_status;
    String? comments;

    FinancialAidApplicationUpsertRequest({this.uuid,this.application_uuid,this.authorizing_uuid,this.citizenship,this.citizenship_other,this.permanent_resident,this.marital_status,this.gender,this.denomination,this.ethnicity,this.program,this.start_term,this.end_term,this.number_of_terms,this.financial_assets,this.spouse_income,this.number_of_children,this.employment_years,this.employment_description,this.vocational_experience_json,this.vocational_direction_json,this.occupation_after_the_program_json,this.area_of_study_json,this.undergrad_gpa,this.regent_gpa,this.is_mature,this.is_nonaccredited,this.award_per_term,this.amount_awarded,this.need_score,this.merit_score,this.current_status,this.comments});
    FinancialAidApplicationUpsertRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        uuid = json['uuid'];
        application_uuid = json['application_uuid'];
        authorizing_uuid = json['authorizing_uuid'];
        citizenship = json['citizenship'];
        citizenship_other = json['citizenship_other'];
        permanent_resident = json['permanent_resident'];
        marital_status = json['marital_status'];
        gender = json['gender'];
        denomination = json['denomination'];
        ethnicity = json['ethnicity'];
        program = json['program'];
        start_term = json['start_term'];
        end_term = json['end_term'];
        number_of_terms = json['number_of_terms'];
        financial_assets = JsonConverters.toDouble(json['financial_assets']);
        spouse_income = JsonConverters.toDouble(json['spouse_income']);
        number_of_children = json['number_of_children'];
        employment_years = json['employment_years'];
        employment_description = json['employment_description'];
        vocational_experience_json = json['vocational_experience_json'];
        vocational_direction_json = json['vocational_direction_json'];
        occupation_after_the_program_json = json['occupation_after_the_program_json'];
        area_of_study_json = json['area_of_study_json'];
        undergrad_gpa = JsonConverters.toDouble(json['undergrad_gpa']);
        regent_gpa = JsonConverters.toDouble(json['regent_gpa']);
        is_mature = json['is_mature'];
        is_nonaccredited = json['is_nonaccredited'];
        award_per_term = JsonConverters.toDouble(json['award_per_term']);
        amount_awarded = JsonConverters.toDouble(json['amount_awarded']);
        need_score = json['need_score'];
        merit_score = json['merit_score'];
        current_status = json['current_status'];
        comments = json['comments'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'uuid': uuid,
        'application_uuid': application_uuid,
        'authorizing_uuid': authorizing_uuid,
        'citizenship': citizenship,
        'citizenship_other': citizenship_other,
        'permanent_resident': permanent_resident,
        'marital_status': marital_status,
        'gender': gender,
        'denomination': denomination,
        'ethnicity': ethnicity,
        'program': program,
        'start_term': start_term,
        'end_term': end_term,
        'number_of_terms': number_of_terms,
        'financial_assets': financial_assets,
        'spouse_income': spouse_income,
        'number_of_children': number_of_children,
        'employment_years': employment_years,
        'employment_description': employment_description,
        'vocational_experience_json': vocational_experience_json,
        'vocational_direction_json': vocational_direction_json,
        'occupation_after_the_program_json': occupation_after_the_program_json,
        'area_of_study_json': area_of_study_json,
        'undergrad_gpa': undergrad_gpa,
        'regent_gpa': regent_gpa,
        'is_mature': is_mature,
        'is_nonaccredited': is_nonaccredited,
        'award_per_term': award_per_term,
        'amount_awarded': amount_awarded,
        'need_score': need_score,
        'merit_score': merit_score,
        'current_status': current_status,
        'comments': comments
    };

    getTypeName() => "FinancialAidApplicationUpsertRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'FinancialAidApplicationUpsertRequest': TypeInfo(TypeOf.Class, create:() => FinancialAidApplicationUpsertRequest()),
});

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