regis

<back to all web services

FinancePayMyTuitionRequest

Requires Authentication
Required permission:CreatePayments
The following routes are available for this service:
POST/Finance/PayMyTuition
import 'package:servicestack/servicestack.dart';

class FinancePayStudentAccountByCardResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    bool? success;

    FinancePayStudentAccountByCardResponse({this.responseStatus,this.success});
    FinancePayStudentAccountByCardResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class FinancePayMyTuitionPayloadRequest implements IConvertible
{
    String? studentGuid;
    String? academicPeriodGUID;
    String? paymentType;
    String? paidOn;
    String? comments;
    String? amount;
    String? currency;
    String? id;
    String? studentResidenceType;

    FinancePayMyTuitionPayloadRequest({this.studentGuid,this.academicPeriodGUID,this.paymentType,this.paidOn,this.comments,this.amount,this.currency,this.id,this.studentResidenceType});
    FinancePayMyTuitionPayloadRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        studentGuid = json['studentGuid'];
        academicPeriodGUID = json['academicPeriodGUID'];
        paymentType = json['paymentType'];
        paidOn = json['paidOn'];
        comments = json['comments'];
        amount = json['amount'];
        currency = json['currency'];
        id = json['id'];
        studentResidenceType = json['studentResidenceType'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'studentGuid': studentGuid,
        'academicPeriodGUID': academicPeriodGUID,
        'paymentType': paymentType,
        'paidOn': paidOn,
        'comments': comments,
        'amount': amount,
        'currency': currency,
        'id': id,
        'studentResidenceType': studentResidenceType
    };

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

class FinancePayMyTuitionRequest implements IConvertible
{
    List<FinancePayMyTuitionPayloadRequest>? payload;
    String? stamp;
    String? hash;

    FinancePayMyTuitionRequest({this.payload,this.stamp,this.hash});
    FinancePayMyTuitionRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        payload = JsonConverters.fromJson(json['payload'],'List<FinancePayMyTuitionPayloadRequest>',context!);
        stamp = json['stamp'];
        hash = json['hash'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'payload': JsonConverters.toJson(payload,'List<FinancePayMyTuitionPayloadRequest>',context!),
        'stamp': stamp,
        'hash': hash
    };

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

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

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

<FinancePayMyTuitionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <hash>String</hash>
  <payload>
    <FinancePayMyTuitionPayloadRequest>
      <AcademicPeriodGUID>String</AcademicPeriodGUID>
      <Currency>String</Currency>
      <Id>String</Id>
      <PaymentType>String</PaymentType>
      <StudentGuid>String</StudentGuid>
      <StudentResidenceType>String</StudentResidenceType>
      <amount>String</amount>
      <comments>String</comments>
      <paidOn>String</paidOn>
    </FinancePayMyTuitionPayloadRequest>
  </payload>
  <stamp>String</stamp>
</FinancePayMyTuitionRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FinancePayStudentAccountByCardResponse 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>
  <success>false</success>
</FinancePayStudentAccountByCardResponse>