regis

<back to all web services

FinanceAccountLateChargeJobResultRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/AccountLate/{reporting_term}/Jobs/Result
import Foundation
import ServiceStack

public class FinanceAccountLateChargeJobResultRequest : Codable
{
    public var authorizing_uuid:String
    public var reporting_term:String
    public var operation_id:String

    required public init(){}
}

public class FinanceAccountLateChargeJobResultResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var job:FinanceAccountLateChargeJobResponse
    public var accounts:[FinanceAccountLateChargeResponse] = []

    required public init(){}
}

public class FinanceAccountLateChargeJobResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var operation_id:String
    public var reporting_term:String
    public var calculation_date:Date
    public var preview_only:Bool
    public var skip_exact_balance:Double?
    public var state:String
    public var total:Int?
    public var current_regent_id:Int?
    public var processed:Int
    public var succeeded:Int
    public var skipped:Int
    public var failed:Int
    public var created_utc:Date
    public var updated_utc:Date
    public var message:String
    public var report_available:Bool
    public var outcomes:[FinanceAccountLateChargeOutcome] = []

    required public init(){}
}

public class FinanceAccountLateChargeOutcome : Codable
{
    public var regent_id:Int
    public var status:String
    public var charge_amount:Double?
    public var charge_status:String
    public var email_status:String
    public var message:String

    required public init(){}
}

public class FinanceAccountLateChargeResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var skip_reason:String
    public var charge_status:String
    public var email_status:String
    public var charge_error:String
    public var email_error:String
    public var regent_id:Int
    public var first_name:String
    public var last_name:String
    public var uuid:String
    public var has_late_reg_fee:Bool
    public var amount_owing:Double
    public var late_fee:Double
    public var interest:Double
    public var active_financial_restrictions:String
    public var new_financial_restriction:String
    public var last_registration_date:Date?

    required public init(){}
}


Swift FinanceAccountLateChargeJobResultRequest 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/Result 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
}
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
		}
	},
	job: 
	{
		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
			}
		]
	},
	accounts: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			skip_reason: String,
			charge_status: String,
			email_status: String,
			charge_error: String,
			email_error: String,
			regent_id: 0,
			first_name: String,
			last_name: String,
			uuid: String,
			has_late_reg_fee: False,
			amount_owing: 0,
			late_fee: 0,
			interest: 0,
			active_financial_restrictions: String,
			new_financial_restriction: String,
			last_registration_date: 0001-01-01
		}
	]
}