regis

FinancialAidSummaryInTermRequest

**Requires Authentication**
Required permission:	FinancialAidPermission

The following routes are available for this service:
POST	/Finance/FinancialAid/Awards/{reporting_term}/Summary

import 'package:servicestack/servicestack.dart';

class FinancialAidAwardResponse implements IConvertible
{
    String? uuid;
    int? regent_id;
    String? first_name;
    String? last_name;
    double? awarded_amount;

    FinancialAidAwardResponse({this.uuid,this.regent_id,this.first_name,this.last_name,this.awarded_amount});
    FinancialAidAwardResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        uuid = json['uuid'];
        regent_id = json['regent_id'];
        first_name = json['first_name'];
        last_name = json['last_name'];
        awarded_amount = JsonConverters.toDouble(json['awarded_amount']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'uuid': uuid,
        'regent_id': regent_id,
        'first_name': first_name,
        'last_name': last_name,
        'awarded_amount': awarded_amount
    };

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

class FinancialAidAwardSummaryInTermResponse implements IConvertible
{
    int? award_id;
    String? award_code;
    String? award_description;
    double? budget_amount;
    double? awarded_amount;
    List<FinancialAidAwardResponse>? person_awards;

    FinancialAidAwardSummaryInTermResponse({this.award_id,this.award_code,this.award_description,this.budget_amount,this.awarded_amount,this.person_awards});
    FinancialAidAwardSummaryInTermResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        award_id = json['award_id'];
        award_code = json['award_code'];
        award_description = json['award_description'];
        budget_amount = JsonConverters.toDouble(json['budget_amount']);
        awarded_amount = JsonConverters.toDouble(json['awarded_amount']);
        person_awards = JsonConverters.fromJson(json['person_awards'],'List<FinancialAidAwardResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'award_id': award_id,
        'award_code': award_code,
        'award_description': award_description,
        'budget_amount': budget_amount,
        'awarded_amount': awarded_amount,
        'person_awards': JsonConverters.toJson(person_awards,'List<FinancialAidAwardResponse>',context!)
    };

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

class FinancialAidSummaryInTermResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? reporting_term;
    List<FinancialAidAwardSummaryInTermResponse>? awards;

    FinancialAidSummaryInTermResponse({this.responseStatus,this.reporting_term,this.awards});
    FinancialAidSummaryInTermResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        reporting_term = json['reporting_term'];
        awards = JsonConverters.fromJson(json['awards'],'List<FinancialAidAwardSummaryInTermResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'reporting_term': reporting_term,
        'awards': JsonConverters.toJson(awards,'List<FinancialAidAwardSummaryInTermResponse>',context!)
    };

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

class FinancialAidSummaryInTermRequest implements IConvertible
{
    String? reporting_term;

    FinancialAidSummaryInTermRequest({this.reporting_term});
    FinancialAidSummaryInTermRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        reporting_term = json['reporting_term'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'reporting_term': reporting_term
    };

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'FinancialAidAwardResponse': TypeInfo(TypeOf.Class, create:() => FinancialAidAwardResponse()),
    'FinancialAidAwardSummaryInTermResponse': TypeInfo(TypeOf.Class, create:() => FinancialAidAwardSummaryInTermResponse()),
    'List<FinancialAidAwardResponse>': TypeInfo(TypeOf.Class, create:() => <FinancialAidAwardResponse>[]),
    'FinancialAidSummaryInTermResponse': TypeInfo(TypeOf.Class, create:() => FinancialAidSummaryInTermResponse()),
    'List<FinancialAidAwardSummaryInTermResponse>': TypeInfo(TypeOf.Class, create:() => <FinancialAidAwardSummaryInTermResponse>[]),
    'FinancialAidSummaryInTermRequest': TypeInfo(TypeOf.Class, create:() => FinancialAidSummaryInTermRequest()),
});

Dart FinancialAidSummaryInTermRequest 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/Awards/{reporting_term}/Summary HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"reporting_term":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"reporting_term":"String","awards":[{"award_id":0,"award_code":"String","award_description":"String","budget_amount":0,"awarded_amount":0,"person_awards":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","awarded_amount":0}]}]}