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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidApplicationUpsertRequest:
    uuid: Optional[str] = None
    application_uuid: Optional[str] = None
    authorizing_uuid: Optional[str] = None
    citizenship: Optional[str] = None
    citizenship_other: Optional[str] = None
    permanent_resident: Optional[str] = None
    marital_status: Optional[str] = None
    gender: Optional[str] = None
    denomination: Optional[str] = None
    ethnicity: Optional[str] = None
    program: Optional[str] = None
    start_term: Optional[str] = None
    end_term: Optional[str] = None
    number_of_terms: Optional[int] = None
    financial_assets: Optional[Decimal] = None
    spouse_income: Optional[Decimal] = None
    number_of_children: Optional[int] = None
    employment_years: Optional[int] = None
    employment_description: Optional[str] = None
    vocational_experience_json: Optional[str] = None
    vocational_direction_json: Optional[str] = None
    occupation_after_the_program_json: Optional[str] = None
    area_of_study_json: Optional[str] = None
    undergrad_gpa: Optional[Decimal] = None
    regent_gpa: Optional[Decimal] = None
    is_mature: bool = False
    is_nonaccredited: bool = False
    award_per_term: Optional[Decimal] = None
    amount_awarded: Optional[Decimal] = None
    need_score: int = 0
    merit_score: int = 0
    current_status: Optional[str] = None
    comments: Optional[str] = None

Python 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"}}