regis

<back to all web services

FinancialAidBudgetUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/FinancialAid/Awards/{reporting_term}/Update
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class FinancialAidBudgetUpdateRequest implements IConvertible
{
    String? authorizing_uuid;
    String? reporting_term;
    Map<int,double?>? award_budgets;
    bool? save_for_all_similar_future_terms;

    FinancialAidBudgetUpdateRequest({this.authorizing_uuid,this.reporting_term,this.award_budgets,this.save_for_all_similar_future_terms});
    FinancialAidBudgetUpdateRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        authorizing_uuid = json['authorizing_uuid'];
        reporting_term = json['reporting_term'];
        award_budgets = JsonConverters.fromJson(json['award_budgets'],'Map<int,double?>',context!);
        save_for_all_similar_future_terms = json['save_for_all_similar_future_terms'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'authorizing_uuid': authorizing_uuid,
        'reporting_term': reporting_term,
        'award_budgets': JsonConverters.toJson(award_budgets,'Map<int,double?>',context!),
        'save_for_all_similar_future_terms': save_for_all_similar_future_terms
    };

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

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

Dart FinancialAidBudgetUpdateRequest 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/Awards/{reporting_term}/Update HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	authorizing_uuid: String,
	reporting_term: String,
	award_budgets: 
	{
		0: 0
	},
	save_for_all_similar_future_terms: False
}
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
	}
}