regis

FinancialAidApplicationUpdateAwardsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Finance/FinancialAid/Application/{application_uuid}/Update/Awards

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 FinancialAidApplicationUpdateAwardRequest:
    award_code: Optional[str] = None
    award_description: Optional[str] = None
    is_awarded: bool = False
    is_eligible: bool = False
    award_amount: Optional[Decimal] = None
    comments: Optional[str] = None
    term: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidApplicationUpdateAwardsRequest:
    application_uuid: Optional[str] = None
    authorizing_uuid: Optional[str] = None
    term: Optional[str] = None
    awards: Optional[List[FinancialAidApplicationUpdateAwardRequest]] = None

Python FinancialAidApplicationUpdateAwardsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Finance/FinancialAid/Application/{application_uuid}/Update/Awards HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	application_uuid: String,
	authorizing_uuid: String,
	term: String,
	awards: 
	[
		{
			award_code: String,
			award_description: String,
			is_awarded: False,
			is_eligible: False,
			award_amount: 0,
			comments: String,
			term: String
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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