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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class FinanceAccountLateChargeJobResultRequest
    {
        public virtual string authorizing_uuid { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual Guid operation_id { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class FinanceAccountLateChargeJobResponse
    {
        public FinanceAccountLateChargeJobResponse()
        {
            outcomes = new List<FinanceAccountLateChargeOutcome>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual Guid operation_id { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual DateTime calculation_date { get; set; }
        public virtual bool preview_only { get; set; }
        public virtual decimal? skip_exact_balance { get; set; }
        public virtual string state { get; set; }
        public virtual int? total { get; set; }
        public virtual int? current_regent_id { get; set; }
        public virtual int processed { get; set; }
        public virtual int succeeded { get; set; }
        public virtual int skipped { get; set; }
        public virtual int failed { get; set; }
        public virtual DateTime created_utc { get; set; }
        public virtual DateTime updated_utc { get; set; }
        public virtual string message { get; set; }
        public virtual bool report_available { get; set; }
        public virtual List<FinanceAccountLateChargeOutcome> outcomes { get; set; }
    }

    public partial class FinanceAccountLateChargeJobResultResponse
    {
        public FinanceAccountLateChargeJobResultResponse()
        {
            accounts = new List<FinanceAccountLateChargeResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual FinanceAccountLateChargeJobResponse job { get; set; }
        public virtual List<FinanceAccountLateChargeResponse> accounts { get; set; }
    }

    public partial class FinanceAccountLateChargeOutcome
    {
        public virtual int regent_id { get; set; }
        public virtual string status { get; set; }
        public virtual decimal? charge_amount { get; set; }
        public virtual string charge_status { get; set; }
        public virtual string email_status { get; set; }
        public virtual string message { get; set; }
    }

    public partial class FinanceAccountLateChargeResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string skip_reason { get; set; }
        public virtual string charge_status { get; set; }
        public virtual string email_status { get; set; }
        public virtual string charge_error { get; set; }
        public virtual string email_error { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string uuid { get; set; }
        public virtual bool has_late_reg_fee { get; set; }
        public virtual decimal amount_owing { get; set; }
        public virtual decimal late_fee { get; set; }
        public virtual decimal interest { get; set; }
        public virtual string active_financial_restrictions { get; set; }
        public virtual string new_financial_restriction { get; set; }
        public virtual DateTime? last_registration_date { get; set; }
    }

}

C# 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
		}
	]
}