regis

FinancialAidAllocationReviewRequest

**Requires Authentication**
Required role:	REGISUserRole

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

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class FinancialAidAllocationCandidateResponse implements IConvertible
{
    String? application_uuid;
    String? uuid;
    int? regent_id;
    String? first_name;
    String? last_name;
    String? application_start_term;
    String? current_status;
    DateTime? submitted_date;
    String? eligibility_tier;
    double? award_target;
    double? committed_amount;
    double? unmet_amount;
    double? proposed_amount;
    String? incomplete_reason;

    FinancialAidAllocationCandidateResponse({this.application_uuid,this.uuid,this.regent_id,this.first_name,this.last_name,this.application_start_term,this.current_status,this.submitted_date,this.eligibility_tier,this.award_target,this.committed_amount,this.unmet_amount,this.proposed_amount,this.incomplete_reason});
    FinancialAidAllocationCandidateResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        application_uuid = json['application_uuid'];
        uuid = json['uuid'];
        regent_id = json['regent_id'];
        first_name = json['first_name'];
        last_name = json['last_name'];
        application_start_term = json['application_start_term'];
        current_status = json['current_status'];
        submitted_date = JsonConverters.fromJson(json['submitted_date'],'DateTime',context!);
        eligibility_tier = json['eligibility_tier'];
        award_target = JsonConverters.toDouble(json['award_target']);
        committed_amount = JsonConverters.toDouble(json['committed_amount']);
        unmet_amount = JsonConverters.toDouble(json['unmet_amount']);
        proposed_amount = JsonConverters.toDouble(json['proposed_amount']);
        incomplete_reason = json['incomplete_reason'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'application_uuid': application_uuid,
        'uuid': uuid,
        'regent_id': regent_id,
        'first_name': first_name,
        'last_name': last_name,
        'application_start_term': application_start_term,
        'current_status': current_status,
        'submitted_date': JsonConverters.toJson(submitted_date,'DateTime',context!),
        'eligibility_tier': eligibility_tier,
        'award_target': award_target,
        'committed_amount': committed_amount,
        'unmet_amount': unmet_amount,
        'proposed_amount': proposed_amount,
        'incomplete_reason': incomplete_reason
    };

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

class FinancialAidAllocationCycleResponse implements IConvertible
{
    String? application_start_term;
    bool? is_fallback_released;
    DateTime? fallback_release_date;
    String? fallback_released_by;
    List<FinancialAidAllocationCandidateResponse>? primary_candidates;
    List<FinancialAidAllocationCandidateResponse>? fallback_candidates;
    List<FinancialAidAllocationCandidateResponse>? manual_review_candidates;

    FinancialAidAllocationCycleResponse({this.application_start_term,this.is_fallback_released,this.fallback_release_date,this.fallback_released_by,this.primary_candidates,this.fallback_candidates,this.manual_review_candidates});
    FinancialAidAllocationCycleResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        application_start_term = json['application_start_term'];
        is_fallback_released = json['is_fallback_released'];
        fallback_release_date = JsonConverters.fromJson(json['fallback_release_date'],'DateTime',context!);
        fallback_released_by = json['fallback_released_by'];
        primary_candidates = JsonConverters.fromJson(json['primary_candidates'],'List<FinancialAidAllocationCandidateResponse>',context!);
        fallback_candidates = JsonConverters.fromJson(json['fallback_candidates'],'List<FinancialAidAllocationCandidateResponse>',context!);
        manual_review_candidates = JsonConverters.fromJson(json['manual_review_candidates'],'List<FinancialAidAllocationCandidateResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'application_start_term': application_start_term,
        'is_fallback_released': is_fallback_released,
        'fallback_release_date': JsonConverters.toJson(fallback_release_date,'DateTime',context!),
        'fallback_released_by': fallback_released_by,
        'primary_candidates': JsonConverters.toJson(primary_candidates,'List<FinancialAidAllocationCandidateResponse>',context!),
        'fallback_candidates': JsonConverters.toJson(fallback_candidates,'List<FinancialAidAllocationCandidateResponse>',context!),
        'manual_review_candidates': JsonConverters.toJson(manual_review_candidates,'List<FinancialAidAllocationCandidateResponse>',context!)
    };

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

class FinancialAidAllocationProposalResponse implements IConvertible
{
    String? application_uuid;
    int? regent_id;
    String? student_name;
    String? application_start_term;
    String? eligibility_tier;
    double? amount;

    FinancialAidAllocationProposalResponse({this.application_uuid,this.regent_id,this.student_name,this.application_start_term,this.eligibility_tier,this.amount});
    FinancialAidAllocationProposalResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        application_uuid = json['application_uuid'];
        regent_id = json['regent_id'];
        student_name = json['student_name'];
        application_start_term = json['application_start_term'];
        eligibility_tier = json['eligibility_tier'];
        amount = JsonConverters.toDouble(json['amount']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'application_uuid': application_uuid,
        'regent_id': regent_id,
        'student_name': student_name,
        'application_start_term': application_start_term,
        'eligibility_tier': eligibility_tier,
        'amount': amount
    };

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

class FinancialAidAllocationAwardResponse implements IConvertible
{
    String? award_code;
    String? award_description;
    double? budget_amount;
    double? planned_or_offered_amount;
    double? accepted_or_issued_amount;
    double? committed_amount;
    double? reclaimable_amount;
    double? proposed_amount;
    double? projected_remaining_amount;
    bool? must_award_whole_budget;
    bool? requires_manual_review;
    String? manual_review_note;
    int? required_recipient_count;
    bool? requires_equal_shares;
    List<FinancialAidAllocationCycleResponse>? application_cycles;
    List<FinancialAidAllocationProposalResponse>? proposals;

    FinancialAidAllocationAwardResponse({this.award_code,this.award_description,this.budget_amount,this.planned_or_offered_amount,this.accepted_or_issued_amount,this.committed_amount,this.reclaimable_amount,this.proposed_amount,this.projected_remaining_amount,this.must_award_whole_budget,this.requires_manual_review,this.manual_review_note,this.required_recipient_count,this.requires_equal_shares,this.application_cycles,this.proposals});
    FinancialAidAllocationAwardResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        award_code = json['award_code'];
        award_description = json['award_description'];
        budget_amount = JsonConverters.toDouble(json['budget_amount']);
        planned_or_offered_amount = JsonConverters.toDouble(json['planned_or_offered_amount']);
        accepted_or_issued_amount = JsonConverters.toDouble(json['accepted_or_issued_amount']);
        committed_amount = JsonConverters.toDouble(json['committed_amount']);
        reclaimable_amount = JsonConverters.toDouble(json['reclaimable_amount']);
        proposed_amount = JsonConverters.toDouble(json['proposed_amount']);
        projected_remaining_amount = JsonConverters.toDouble(json['projected_remaining_amount']);
        must_award_whole_budget = json['must_award_whole_budget'];
        requires_manual_review = json['requires_manual_review'];
        manual_review_note = json['manual_review_note'];
        required_recipient_count = json['required_recipient_count'];
        requires_equal_shares = json['requires_equal_shares'];
        application_cycles = JsonConverters.fromJson(json['application_cycles'],'List<FinancialAidAllocationCycleResponse>',context!);
        proposals = JsonConverters.fromJson(json['proposals'],'List<FinancialAidAllocationProposalResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'award_code': award_code,
        'award_description': award_description,
        'budget_amount': budget_amount,
        'planned_or_offered_amount': planned_or_offered_amount,
        'accepted_or_issued_amount': accepted_or_issued_amount,
        'committed_amount': committed_amount,
        'reclaimable_amount': reclaimable_amount,
        'proposed_amount': proposed_amount,
        'projected_remaining_amount': projected_remaining_amount,
        'must_award_whole_budget': must_award_whole_budget,
        'requires_manual_review': requires_manual_review,
        'manual_review_note': manual_review_note,
        'required_recipient_count': required_recipient_count,
        'requires_equal_shares': requires_equal_shares,
        'application_cycles': JsonConverters.toJson(application_cycles,'List<FinancialAidAllocationCycleResponse>',context!),
        'proposals': JsonConverters.toJson(proposals,'List<FinancialAidAllocationProposalResponse>',context!)
    };

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

class FinancialAidAllocationConflictResponse implements IConvertible
{
    String? award_code;
    String? award_description;
    String? application_start_term;
    String? fallback_application_uuid;
    String? fallback_student_name;
    String? fallback_status;
    double? reclaimable_amount;
    String? primary_application_uuid;
    String? primary_student_name;

    FinancialAidAllocationConflictResponse({this.award_code,this.award_description,this.application_start_term,this.fallback_application_uuid,this.fallback_student_name,this.fallback_status,this.reclaimable_amount,this.primary_application_uuid,this.primary_student_name});
    FinancialAidAllocationConflictResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        award_code = json['award_code'];
        award_description = json['award_description'];
        application_start_term = json['application_start_term'];
        fallback_application_uuid = json['fallback_application_uuid'];
        fallback_student_name = json['fallback_student_name'];
        fallback_status = json['fallback_status'];
        reclaimable_amount = JsonConverters.toDouble(json['reclaimable_amount']);
        primary_application_uuid = json['primary_application_uuid'];
        primary_student_name = json['primary_student_name'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'award_code': award_code,
        'award_description': award_description,
        'application_start_term': application_start_term,
        'fallback_application_uuid': fallback_application_uuid,
        'fallback_student_name': fallback_student_name,
        'fallback_status': fallback_status,
        'reclaimable_amount': reclaimable_amount,
        'primary_application_uuid': primary_application_uuid,
        'primary_student_name': primary_student_name
    };

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

class FinancialAidAllocationReviewResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? reporting_term;
    double? budget_amount;
    double? committed_amount;
    double? proposed_amount;
    double? projected_unused_amount;
    double? actionable_unmet_amount;
    List<FinancialAidAllocationAwardResponse>? awards;
    List<FinancialAidAllocationCandidateResponse>? incomplete_candidates;
    List<FinancialAidAllocationConflictResponse>? conflicts;

    FinancialAidAllocationReviewResponse({this.responseStatus,this.reporting_term,this.budget_amount,this.committed_amount,this.proposed_amount,this.projected_unused_amount,this.actionable_unmet_amount,this.awards,this.incomplete_candidates,this.conflicts});
    FinancialAidAllocationReviewResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        reporting_term = json['reporting_term'];
        budget_amount = JsonConverters.toDouble(json['budget_amount']);
        committed_amount = JsonConverters.toDouble(json['committed_amount']);
        proposed_amount = JsonConverters.toDouble(json['proposed_amount']);
        projected_unused_amount = JsonConverters.toDouble(json['projected_unused_amount']);
        actionable_unmet_amount = JsonConverters.toDouble(json['actionable_unmet_amount']);
        awards = JsonConverters.fromJson(json['awards'],'List<FinancialAidAllocationAwardResponse>',context!);
        incomplete_candidates = JsonConverters.fromJson(json['incomplete_candidates'],'List<FinancialAidAllocationCandidateResponse>',context!);
        conflicts = JsonConverters.fromJson(json['conflicts'],'List<FinancialAidAllocationConflictResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'reporting_term': reporting_term,
        'budget_amount': budget_amount,
        'committed_amount': committed_amount,
        'proposed_amount': proposed_amount,
        'projected_unused_amount': projected_unused_amount,
        'actionable_unmet_amount': actionable_unmet_amount,
        'awards': JsonConverters.toJson(awards,'List<FinancialAidAllocationAwardResponse>',context!),
        'incomplete_candidates': JsonConverters.toJson(incomplete_candidates,'List<FinancialAidAllocationCandidateResponse>',context!),
        'conflicts': JsonConverters.toJson(conflicts,'List<FinancialAidAllocationConflictResponse>',context!)
    };

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

class FinancialAidAllocationReviewRequest implements IConvertible
{
    String? reporting_term;
    String? authorizing_uuid;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'FinancialAidAllocationCandidateResponse': TypeInfo(TypeOf.Class, create:() => FinancialAidAllocationCandidateResponse()),
    'FinancialAidAllocationCycleResponse': TypeInfo(TypeOf.Class, create:() => FinancialAidAllocationCycleResponse()),
    'List<FinancialAidAllocationCandidateResponse>': TypeInfo(TypeOf.Class, create:() => <FinancialAidAllocationCandidateResponse>[]),
    'FinancialAidAllocationProposalResponse': TypeInfo(TypeOf.Class, create:() => FinancialAidAllocationProposalResponse()),
    'FinancialAidAllocationAwardResponse': TypeInfo(TypeOf.Class, create:() => FinancialAidAllocationAwardResponse()),
    'List<FinancialAidAllocationCycleResponse>': TypeInfo(TypeOf.Class, create:() => <FinancialAidAllocationCycleResponse>[]),
    'List<FinancialAidAllocationProposalResponse>': TypeInfo(TypeOf.Class, create:() => <FinancialAidAllocationProposalResponse>[]),
    'FinancialAidAllocationConflictResponse': TypeInfo(TypeOf.Class, create:() => FinancialAidAllocationConflictResponse()),
    'FinancialAidAllocationReviewResponse': TypeInfo(TypeOf.Class, create:() => FinancialAidAllocationReviewResponse()),
    'List<FinancialAidAllocationAwardResponse>': TypeInfo(TypeOf.Class, create:() => <FinancialAidAllocationAwardResponse>[]),
    'List<FinancialAidAllocationConflictResponse>': TypeInfo(TypeOf.Class, create:() => <FinancialAidAllocationConflictResponse>[]),
    'FinancialAidAllocationReviewRequest': TypeInfo(TypeOf.Class, create:() => FinancialAidAllocationReviewRequest()),
});

Dart FinancialAidAllocationReviewRequest DTOs

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

HTTP + XML

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

POST /Finance/FinancialAid/AllocationReview/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinancialAidAllocationReviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <reporting_term>String</reporting_term>
</FinancialAidAllocationReviewRequest>

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

<FinancialAidAllocationReviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <actionable_unmet_amount>0</actionable_unmet_amount>
  <awards>
    <FinancialAidAllocationAwardResponse>
      <accepted_or_issued_amount>0</accepted_or_issued_amount>
      <application_cycles>
        <FinancialAidAllocationCycleResponse>
          <application_start_term>String</application_start_term>
          <fallback_candidates>
            <FinancialAidAllocationCandidateResponse>
              <application_start_term>String</application_start_term>
              <application_uuid>String</application_uuid>
              <award_target>0</award_target>
              <committed_amount>0</committed_amount>
              <current_status>String</current_status>
              <eligibility_tier>String</eligibility_tier>
              <first_name>String</first_name>
              <incomplete_reason>String</incomplete_reason>
              <last_name>String</last_name>
              <proposed_amount>0</proposed_amount>
              <regent_id>0</regent_id>
              <submitted_date>0001-01-01T00:00:00</submitted_date>
              <unmet_amount>0</unmet_amount>
              <uuid>String</uuid>
            </FinancialAidAllocationCandidateResponse>
          </fallback_candidates>
          <fallback_release_date>0001-01-01T00:00:00</fallback_release_date>
          <fallback_released_by>String</fallback_released_by>
          <is_fallback_released>false</is_fallback_released>
          <manual_review_candidates>
            <FinancialAidAllocationCandidateResponse>
              <application_start_term>String</application_start_term>
              <application_uuid>String</application_uuid>
              <award_target>0</award_target>
              <committed_amount>0</committed_amount>
              <current_status>String</current_status>
              <eligibility_tier>String</eligibility_tier>
              <first_name>String</first_name>
              <incomplete_reason>String</incomplete_reason>
              <last_name>String</last_name>
              <proposed_amount>0</proposed_amount>
              <regent_id>0</regent_id>
              <submitted_date>0001-01-01T00:00:00</submitted_date>
              <unmet_amount>0</unmet_amount>
              <uuid>String</uuid>
            </FinancialAidAllocationCandidateResponse>
          </manual_review_candidates>
          <primary_candidates>
            <FinancialAidAllocationCandidateResponse>
              <application_start_term>String</application_start_term>
              <application_uuid>String</application_uuid>
              <award_target>0</award_target>
              <committed_amount>0</committed_amount>
              <current_status>String</current_status>
              <eligibility_tier>String</eligibility_tier>
              <first_name>String</first_name>
              <incomplete_reason>String</incomplete_reason>
              <last_name>String</last_name>
              <proposed_amount>0</proposed_amount>
              <regent_id>0</regent_id>
              <submitted_date>0001-01-01T00:00:00</submitted_date>
              <unmet_amount>0</unmet_amount>
              <uuid>String</uuid>
            </FinancialAidAllocationCandidateResponse>
          </primary_candidates>
        </FinancialAidAllocationCycleResponse>
      </application_cycles>
      <award_code>String</award_code>
      <award_description>String</award_description>
      <budget_amount>0</budget_amount>
      <committed_amount>0</committed_amount>
      <manual_review_note>String</manual_review_note>
      <must_award_whole_budget>false</must_award_whole_budget>
      <planned_or_offered_amount>0</planned_or_offered_amount>
      <projected_remaining_amount>0</projected_remaining_amount>
      <proposals>
        <FinancialAidAllocationProposalResponse>
          <amount>0</amount>
          <application_start_term>String</application_start_term>
          <application_uuid>String</application_uuid>
          <eligibility_tier>String</eligibility_tier>
          <regent_id>0</regent_id>
          <student_name>String</student_name>
        </FinancialAidAllocationProposalResponse>
      </proposals>
      <proposed_amount>0</proposed_amount>
      <reclaimable_amount>0</reclaimable_amount>
      <required_recipient_count>0</required_recipient_count>
      <requires_equal_shares>false</requires_equal_shares>
      <requires_manual_review>false</requires_manual_review>
    </FinancialAidAllocationAwardResponse>
  </awards>
  <budget_amount>0</budget_amount>
  <committed_amount>0</committed_amount>
  <conflicts>
    <FinancialAidAllocationConflictResponse>
      <application_start_term>String</application_start_term>
      <award_code>String</award_code>
      <award_description>String</award_description>
      <fallback_application_uuid>String</fallback_application_uuid>
      <fallback_status>String</fallback_status>
      <fallback_student_name>String</fallback_student_name>
      <primary_application_uuid>String</primary_application_uuid>
      <primary_student_name>String</primary_student_name>
      <reclaimable_amount>0</reclaimable_amount>
    </FinancialAidAllocationConflictResponse>
  </conflicts>
  <incomplete_candidates>
    <FinancialAidAllocationCandidateResponse>
      <application_start_term>String</application_start_term>
      <application_uuid>String</application_uuid>
      <award_target>0</award_target>
      <committed_amount>0</committed_amount>
      <current_status>String</current_status>
      <eligibility_tier>String</eligibility_tier>
      <first_name>String</first_name>
      <incomplete_reason>String</incomplete_reason>
      <last_name>String</last_name>
      <proposed_amount>0</proposed_amount>
      <regent_id>0</regent_id>
      <submitted_date>0001-01-01T00:00:00</submitted_date>
      <unmet_amount>0</unmet_amount>
      <uuid>String</uuid>
    </FinancialAidAllocationCandidateResponse>
  </incomplete_candidates>
  <projected_unused_amount>0</projected_unused_amount>
  <proposed_amount>0</proposed_amount>
  <reporting_term>String</reporting_term>
</FinancialAidAllocationReviewResponse>