regis

<back to all web services

FinancialAidApplicationUpdateAwardsRequest

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

class FinancialAidApplicationUpdateAwardRequest implements IConvertible
{
    String? award_code;
    String? award_description;
    bool? is_awarded;
    bool? is_eligible;
    double? award_amount;
    String? comments;
    String? term;

    FinancialAidApplicationUpdateAwardRequest({this.award_code,this.award_description,this.is_awarded,this.is_eligible,this.award_amount,this.comments,this.term});
    FinancialAidApplicationUpdateAwardRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        award_code = json['award_code'];
        award_description = json['award_description'];
        is_awarded = json['is_awarded'];
        is_eligible = json['is_eligible'];
        award_amount = JsonConverters.toDouble(json['award_amount']);
        comments = json['comments'];
        term = json['term'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'award_code': award_code,
        'award_description': award_description,
        'is_awarded': is_awarded,
        'is_eligible': is_eligible,
        'award_amount': award_amount,
        'comments': comments,
        'term': term
    };

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

class FinancialAidApplicationUpdateAwardsRequest implements IConvertible
{
    String? application_uuid;
    String? authorizing_uuid;
    String? term;
    List<FinancialAidApplicationUpdateAwardRequest>? awards;

    FinancialAidApplicationUpdateAwardsRequest({this.application_uuid,this.authorizing_uuid,this.term,this.awards});
    FinancialAidApplicationUpdateAwardsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        application_uuid = json['application_uuid'];
        authorizing_uuid = json['authorizing_uuid'];
        term = json['term'];
        awards = JsonConverters.fromJson(json['awards'],'List<FinancialAidApplicationUpdateAwardRequest>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'application_uuid': application_uuid,
        'authorizing_uuid': authorizing_uuid,
        'term': term,
        'awards': JsonConverters.toJson(awards,'List<FinancialAidApplicationUpdateAwardRequest>',context!)
    };

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

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

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

<FinancialAidApplicationUpdateAwardsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <application_uuid>String</application_uuid>
  <authorizing_uuid>String</authorizing_uuid>
  <awards>
    <FinancialAidApplicationUpdateAwardRequest>
      <award_amount>0</award_amount>
      <award_code>String</award_code>
      <award_description>String</award_description>
      <comments>String</comments>
      <is_awarded>false</is_awarded>
      <is_eligible>false</is_eligible>
      <term>String</term>
    </FinancialAidApplicationUpdateAwardRequest>
  </awards>
  <term>String</term>
</FinancialAidApplicationUpdateAwardsRequest>
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>