regis

<back to all web services

FinancialAidApplicationUpdateBatchRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/FinancialAid/Applications/Update
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 FinancialAidApplicationUpdateBatchItemRequest:
    application_uuid: Optional[str] = None
    award_per_term: Decimal = decimal.Decimal(0)
    current_status: Optional[str] = None
    end_term: Optional[str] = None
    comments: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidApplicationUpdateBatchRequest:
    authorizing_uuid: Optional[str] = None
    financial_aid_applications: Optional[List[FinancialAidApplicationUpdateBatchItemRequest]] = None

Python FinancialAidApplicationUpdateBatchRequest 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/Applications/Update HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	authorizing_uuid: String,
	financial_aid_applications: 
	[
		{
			application_uuid: String,
			award_per_term: 0,
			current_status: String,
			end_term: String,
			comments: 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
	}
}