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

<FinancialAidBudgetUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <award_budgets xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintdecimal>
      <d2p1:Key>0</d2p1:Key>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:KeyValueOfintdecimal>
  </award_budgets>
  <reporting_term>String</reporting_term>
  <save_for_all_similar_future_terms>false</save_for_all_similar_future_terms>
</FinancialAidBudgetUpdateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>