regis

<back to all web services

FinanceAccountLateChargeJobStatusRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/AccountLate/{reporting_term}/Jobs/Status
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class FinanceAccountLateChargeJobStatusRequest
            Public Overridable Property authorizing_uuid As String
            Public Overridable Property reporting_term As String
            Public Overridable Property operation_id As Guid
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class FinanceAccountLateChargeJobResponse
            Public Sub New()
                outcomes = New List(Of FinanceAccountLateChargeOutcome)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property operation_id As Guid
            Public Overridable Property reporting_term As String
            Public Overridable Property calculation_date As Date
            Public Overridable Property preview_only As Boolean
            Public Overridable Property skip_exact_balance As Nullable(Of Decimal)
            Public Overridable Property state As String
            Public Overridable Property total As Nullable(Of Integer)
            Public Overridable Property current_regent_id As Nullable(Of Integer)
            Public Overridable Property processed As Integer
            Public Overridable Property succeeded As Integer
            Public Overridable Property skipped As Integer
            Public Overridable Property failed As Integer
            Public Overridable Property created_utc As Date
            Public Overridable Property updated_utc As Date
            Public Overridable Property message As String
            Public Overridable Property report_available As Boolean
            Public Overridable Property outcomes As List(Of FinanceAccountLateChargeOutcome)
        End Class

        Public Partial Class FinanceAccountLateChargeOutcome
            Public Overridable Property regent_id As Integer
            Public Overridable Property status As String
            Public Overridable Property charge_amount As Nullable(Of Decimal)
            Public Overridable Property charge_status As String
            Public Overridable Property email_status As String
            Public Overridable Property message As String
        End Class
    End Namespace
End Namespace

VB.NET FinanceAccountLateChargeJobStatusRequest 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/Status 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
		}
	},
	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
		}
	]
}