regis

<back to all web services

RegistrationBillingAuditReportRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/registration/billing-audit-reports
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 RegistrationBillingAuditReportRequest
    {
        public virtual string reporting_term { get; set; }
        public virtual DateTime from_date { get; set; }
        public virtual DateTime to_date { get; set; }
        public virtual string authorizing_uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class RegistrationBillingAuditReportResponse
    {
        public RegistrationBillingAuditReportResponse()
        {
            parity = new List<RegistrationBillingParityAuditResponse>{};
            completeness = new List<RegistrationBillingCompletenessAuditResponse>{};
            failures = new List<RegistrationBillingFailureAuditResponse>{};
            drift = new List<RegistrationBillingDriftAuditResponse>{};
        }

        public virtual List<RegistrationBillingParityAuditResponse> parity { get; set; }
        public virtual List<RegistrationBillingCompletenessAuditResponse> completeness { get; set; }
        public virtual List<RegistrationBillingFailureAuditResponse> failures { get; set; }
        public virtual List<RegistrationBillingDriftAuditResponse> drift { get; set; }
    }

    public partial class RegistrationBillingCompletenessAuditResponse
    {
        public virtual int transaction_id { get; set; }
        public virtual string transaction_uuid { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual DateTime finished_datetime { get; set; }
        public virtual string operation { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string student_uuid { get; set; }
        public virtual string student_name { get; set; }
        public virtual int invoice_count { get; set; }
        public virtual decimal invoice_net { get; set; }
        public virtual decimal item_net { get; set; }
        public virtual int gp_success_count { get; set; }
        public virtual int gp_failure_count { get; set; }
        public virtual string calculation_status { get; set; }
        public virtual string calculation_findings { get; set; }
        public virtual string status { get; set; }
        public virtual string findings { get; set; }
        public virtual DateTime? resolved_datetime { get; set; }
        public virtual string resolved_by_uuid { get; set; }
    }

    public partial class RegistrationBillingDriftAuditResponse
    {
        public RegistrationBillingDriftAuditResponse()
        {
            section_course_codes = new Dictionary<int, string>{};
        }

        public virtual int transaction_id { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string workflow { get; set; }
        public virtual int calculation_count { get; set; }
        public virtual DateTime first_calculation { get; set; }
        public virtual DateTime final_calculation { get; set; }
        public virtual bool changed { get; set; }
        public virtual string persistence_status { get; set; }
        public virtual string persistence_findings { get; set; }
        public virtual string first_summary_json { get; set; }
        public virtual string final_summary_json { get; set; }
        public virtual Dictionary<int, string> section_course_codes { get; set; }
    }

    public partial class RegistrationBillingFailureAuditResponse
    {
        public virtual string source { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual long id { get; set; }
        public virtual DateTime timestamp { get; set; }
        public virtual string workflow { get; set; }
        public virtual int regent_id { get; set; }
        public virtual int? transaction_id { get; set; }
        public virtual string invoice_id { get; set; }
        public virtual string gp_document_number { get; set; }
        public virtual decimal? amount { get; set; }
        public virtual string error { get; set; }
    }

    public partial class RegistrationBillingParityAuditResponse
    {
        public virtual long execution_id { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual DateTime timestamp { get; set; }
        public virtual string workflow { get; set; }
        public virtual string execution_mode { get; set; }
        public virtual int regent_id { get; set; }
        public virtual int? transaction_id { get; set; }
        public virtual bool matches { get; set; }
        public virtual bool? legacy_succeeded { get; set; }
        public virtual bool? composed_succeeded { get; set; }
        public virtual string differences { get; set; }
        public virtual string request_summary_json { get; set; }
        public virtual string legacy_summary_json { get; set; }
        public virtual string composed_summary_json { get; set; }
    }

}

C# RegistrationBillingAuditReportRequest 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 /registration/billing-audit-reports HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	reporting_term: String,
	from_date: 0001-01-01,
	to_date: 0001-01-01,
	authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	parity: 
	[
		{
			execution_id: 0,
			reporting_term: String,
			timestamp: 0001-01-01,
			workflow: String,
			execution_mode: String,
			regent_id: 0,
			transaction_id: 0,
			matches: False,
			legacy_succeeded: False,
			composed_succeeded: False,
			differences: String,
			request_summary_json: String,
			legacy_summary_json: String,
			composed_summary_json: String
		}
	],
	completeness: 
	[
		{
			transaction_id: 0,
			transaction_uuid: String,
			reporting_term: String,
			finished_datetime: 0001-01-01,
			operation: String,
			regent_id: 0,
			student_uuid: String,
			student_name: String,
			invoice_count: 0,
			invoice_net: 0,
			item_net: 0,
			gp_success_count: 0,
			gp_failure_count: 0,
			calculation_status: String,
			calculation_findings: String,
			status: String,
			findings: String,
			resolved_datetime: 0001-01-01,
			resolved_by_uuid: String
		}
	],
	failures: 
	[
		{
			source: String,
			reporting_term: String,
			id: 0,
			timestamp: 0001-01-01,
			workflow: String,
			regent_id: 0,
			transaction_id: 0,
			invoice_id: String,
			gp_document_number: String,
			amount: 0,
			error: String
		}
	],
	drift: 
	[
		{
			transaction_id: 0,
			reporting_term: String,
			regent_id: 0,
			workflow: String,
			calculation_count: 0,
			first_calculation: 0001-01-01,
			final_calculation: 0001-01-01,
			changed: False,
			persistence_status: String,
			persistence_findings: String,
			first_summary_json: String,
			final_summary_json: String,
			section_course_codes: 
			{
				0: String
			}
		}
	]
}