regis

<back to all web services

FinancialAidApplicationFileRequest

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

class FileSimpleResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? uuid;
    String? name;
    String? Extension;
    int? size;

    FileSimpleResponse({this.responseStatus,this.uuid,this.name,this.Extension,this.size});
    FileSimpleResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        uuid = json['uuid'];
        name = json['name'];
        Extension = json['extension'];
        size = json['size'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'uuid': uuid,
        'name': name,
        'extension': Extension,
        'size': size
    };

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

class FileResponse extends FileSimpleResponse implements IConvertible
{
    String? type;
    Uint8List? content;

    FileResponse({this.type,this.content});
    FileResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        type = json['type'];
        content = JsonConverters.fromJson(json['content'],'Uint8List',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'type': type,
        'content': JsonConverters.toJson(content,'Uint8List',context!)
    });

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

class FinancialAidApplicationFileRequest implements IConvertible
{
    String? application_uuid;
    String? file_uuid;

    FinancialAidApplicationFileRequest({this.application_uuid,this.file_uuid});
    FinancialAidApplicationFileRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'FileSimpleResponse': TypeInfo(TypeOf.Class, create:() => FileSimpleResponse()),
    'FileResponse': TypeInfo(TypeOf.Class, create:() => FileResponse()),
    'Uint8List': TypeInfo(TypeOf.Class, create:() => Uint8List(0)),
    'FinancialAidApplicationFileRequest': TypeInfo(TypeOf.Class, create:() => FinancialAidApplicationFileRequest()),
});

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

<FinancialAidApplicationFileRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <application_uuid>String</application_uuid>
  <file_uuid>String</file_uuid>
</FinancialAidApplicationFileRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FileResponse 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>
  <extension>String</extension>
  <name>String</name>
  <size>0</size>
  <uuid>String</uuid>
  <content>AA==</content>
  <type>String</type>
</FileResponse>