regis

<back to all web services

FinanceBalanceRequest

Requires Authentication
Required permission:ReadAccountBalance
The following routes are available for this service:
POST/Finance/Balance/{uuid}
import 'package:servicestack/servicestack.dart';

class FinanceBalanceResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    String? first_name;
    String? last_name;
    String? email;
    String? current_program;
    String? first_regent_term;
    DateTime? first_registered_date;
    DateTime? last_registered_date;
    String? uuid;
    double? total_payments;
    double? total_charges;
    double? balance;
    double? gp_raw_balance;
    bool? is_vendor;
    bool? is_customer;

    FinanceBalanceResponse({this.responseStatus,this.regent_id,this.first_name,this.last_name,this.email,this.current_program,this.first_regent_term,this.first_registered_date,this.last_registered_date,this.uuid,this.total_payments,this.total_charges,this.balance,this.gp_raw_balance,this.is_vendor,this.is_customer});
    FinanceBalanceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        regent_id = json['regent_id'];
        first_name = json['first_name'];
        last_name = json['last_name'];
        email = json['email'];
        current_program = json['current_program'];
        first_regent_term = json['first_regent_term'];
        first_registered_date = JsonConverters.fromJson(json['first_registered_date'],'DateTime',context!);
        last_registered_date = JsonConverters.fromJson(json['last_registered_date'],'DateTime',context!);
        uuid = json['uuid'];
        total_payments = JsonConverters.toDouble(json['total_payments']);
        total_charges = JsonConverters.toDouble(json['total_charges']);
        balance = JsonConverters.toDouble(json['balance']);
        gp_raw_balance = JsonConverters.toDouble(json['gp_raw_balance']);
        is_vendor = json['is_vendor'];
        is_customer = json['is_customer'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'regent_id': regent_id,
        'first_name': first_name,
        'last_name': last_name,
        'email': email,
        'current_program': current_program,
        'first_regent_term': first_regent_term,
        'first_registered_date': JsonConverters.toJson(first_registered_date,'DateTime',context!),
        'last_registered_date': JsonConverters.toJson(last_registered_date,'DateTime',context!),
        'uuid': uuid,
        'total_payments': total_payments,
        'total_charges': total_charges,
        'balance': balance,
        'gp_raw_balance': gp_raw_balance,
        'is_vendor': is_vendor,
        'is_customer': is_customer
    };

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

class FinanceBalanceRequest implements IConvertible
{
    String? uuid;

    FinanceBalanceRequest({this.uuid});
    FinanceBalanceRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'FinanceBalanceResponse': TypeInfo(TypeOf.Class, create:() => FinanceBalanceResponse()),
    'FinanceBalanceRequest': TypeInfo(TypeOf.Class, create:() => FinanceBalanceRequest()),
});

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

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

<FinanceBalanceResponse 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>
  <balance>0</balance>
  <current_program>String</current_program>
  <email>String</email>
  <first_name>String</first_name>
  <first_regent_term>String</first_regent_term>
  <first_registered_date>0001-01-01T00:00:00</first_registered_date>
  <gp_raw_balance>0</gp_raw_balance>
  <is_customer>false</is_customer>
  <is_vendor>false</is_vendor>
  <last_name>String</last_name>
  <last_registered_date>0001-01-01T00:00:00</last_registered_date>
  <regent_id>0</regent_id>
  <total_charges>0</total_charges>
  <total_payments>0</total_payments>
  <uuid>String</uuid>
</FinanceBalanceResponse>