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

export class FinanceAccountLateChargeOutcome
{
    public regent_id: number;
    public status: string;
    public charge_amount?: number;
    public charge_status: string;
    public email_status: string;
    public message: string;

    public constructor(init?: Partial<FinanceAccountLateChargeOutcome>) { (Object as any).assign(this, init); }
}

export class FinanceAccountLateChargeJobResponse
{
    public responseStatus: ResponseStatus;
    public operation_id: string;
    public reporting_term: string;
    public calculation_date: string;
    public preview_only: boolean;
    public skip_exact_balance?: number;
    public state: string;
    public total?: number;
    public current_regent_id?: number;
    public processed: number;
    public succeeded: number;
    public skipped: number;
    public failed: number;
    public created_utc: string;
    public updated_utc: string;
    public message: string;
    public report_available: boolean;
    public outcomes: FinanceAccountLateChargeOutcome[];

    public constructor(init?: Partial<FinanceAccountLateChargeJobResponse>) { (Object as any).assign(this, init); }
}

export class FinanceAccountLateChargeJobStatusRequest
{
    public authorizing_uuid: string;
    public reporting_term: string;
    public operation_id: string;

    public constructor(init?: Partial<FinanceAccountLateChargeJobStatusRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	]
}