regis

<back to all web services

FinanceAccountLateChargeJobStartRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/AccountLate/{reporting_term}/Jobs
import 'package:servicestack/servicestack.dart';

class FinanceAccountLateChargeOutcome implements IConvertible
{
    int? regent_id;
    String? status;
    double? charge_amount;
    String? charge_status;
    String? email_status;
    String? message;

    FinanceAccountLateChargeOutcome({this.regent_id,this.status,this.charge_amount,this.charge_status,this.email_status,this.message});
    FinanceAccountLateChargeOutcome.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        regent_id = json['regent_id'];
        status = json['status'];
        charge_amount = JsonConverters.toDouble(json['charge_amount']);
        charge_status = json['charge_status'];
        email_status = json['email_status'];
        message = json['message'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'regent_id': regent_id,
        'status': status,
        'charge_amount': charge_amount,
        'charge_status': charge_status,
        'email_status': email_status,
        'message': message
    };

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

class FinanceAccountLateChargeJobResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? operation_id;
    String? reporting_term;
    DateTime? calculation_date;
    bool? preview_only;
    double? skip_exact_balance;
    String? state;
    int? total;
    int? current_regent_id;
    int? processed;
    int? succeeded;
    int? skipped;
    int? failed;
    DateTime? created_utc;
    DateTime? updated_utc;
    String? message;
    bool? report_available;
    List<FinanceAccountLateChargeOutcome>? outcomes;

    FinanceAccountLateChargeJobResponse({this.responseStatus,this.operation_id,this.reporting_term,this.calculation_date,this.preview_only,this.skip_exact_balance,this.state,this.total,this.current_regent_id,this.processed,this.succeeded,this.skipped,this.failed,this.created_utc,this.updated_utc,this.message,this.report_available,this.outcomes});
    FinanceAccountLateChargeJobResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        operation_id = json['operation_id'];
        reporting_term = json['reporting_term'];
        calculation_date = JsonConverters.fromJson(json['calculation_date'],'DateTime',context!);
        preview_only = json['preview_only'];
        skip_exact_balance = JsonConverters.toDouble(json['skip_exact_balance']);
        state = json['state'];
        total = json['total'];
        current_regent_id = json['current_regent_id'];
        processed = json['processed'];
        succeeded = json['succeeded'];
        skipped = json['skipped'];
        failed = json['failed'];
        created_utc = JsonConverters.fromJson(json['created_utc'],'DateTime',context!);
        updated_utc = JsonConverters.fromJson(json['updated_utc'],'DateTime',context!);
        message = json['message'];
        report_available = json['report_available'];
        outcomes = JsonConverters.fromJson(json['outcomes'],'List<FinanceAccountLateChargeOutcome>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'operation_id': operation_id,
        'reporting_term': reporting_term,
        'calculation_date': JsonConverters.toJson(calculation_date,'DateTime',context!),
        'preview_only': preview_only,
        'skip_exact_balance': skip_exact_balance,
        'state': state,
        'total': total,
        'current_regent_id': current_regent_id,
        'processed': processed,
        'succeeded': succeeded,
        'skipped': skipped,
        'failed': failed,
        'created_utc': JsonConverters.toJson(created_utc,'DateTime',context!),
        'updated_utc': JsonConverters.toJson(updated_utc,'DateTime',context!),
        'message': message,
        'report_available': report_available,
        'outcomes': JsonConverters.toJson(outcomes,'List<FinanceAccountLateChargeOutcome>',context!)
    };

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

class FinanceAccountLateChargeJobStartRequest implements IConvertible
{
    String? authorizing_uuid;
    String? reporting_term;
    String? operation_id;
    DateTime? calculation_date;
    bool? preview_only;
    double? skip_exact_balance;
    bool? send_emails;

    FinanceAccountLateChargeJobStartRequest({this.authorizing_uuid,this.reporting_term,this.operation_id,this.calculation_date,this.preview_only,this.skip_exact_balance,this.send_emails});
    FinanceAccountLateChargeJobStartRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        authorizing_uuid = json['authorizing_uuid'];
        reporting_term = json['reporting_term'];
        operation_id = json['operation_id'];
        calculation_date = JsonConverters.fromJson(json['calculation_date'],'DateTime',context!);
        preview_only = json['preview_only'];
        skip_exact_balance = JsonConverters.toDouble(json['skip_exact_balance']);
        send_emails = json['send_emails'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'authorizing_uuid': authorizing_uuid,
        'reporting_term': reporting_term,
        'operation_id': operation_id,
        'calculation_date': JsonConverters.toJson(calculation_date,'DateTime',context!),
        'preview_only': preview_only,
        'skip_exact_balance': skip_exact_balance,
        'send_emails': send_emails
    };

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

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

Dart FinanceAccountLateChargeJobStartRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Finance/AccountLate/{reporting_term}/Jobs HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	authorizing_uuid: String,
	reporting_term: String,
	operation_id: 00000000000000000000000000000000,
	calculation_date: 0001-01-01,
	preview_only: False,
	skip_exact_balance: 0,
	send_emails: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	operation_id: 00000000000000000000000000000000,
	reporting_term: String,
	calculation_date: 0001-01-01,
	preview_only: False,
	skip_exact_balance: 0,
	state: String,
	total: 0,
	current_regent_id: 0,
	processed: 0,
	succeeded: 0,
	skipped: 0,
	failed: 0,
	created_utc: 0001-01-01,
	updated_utc: 0001-01-01,
	message: String,
	report_available: False,
	outcomes: 
	[
		{
			regent_id: 0,
			status: String,
			charge_amount: 0,
			charge_status: String,
			email_status: String,
			message: String
		}
	]
}