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
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RegistrationBillingParityAuditResponse() = 
        member val execution_id:Int64 = new Int64() with get,set
        member val reporting_term:String = null with get,set
        member val timestamp:DateTime = new DateTime() with get,set
        member val workflow:String = null with get,set
        member val execution_mode:String = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val transaction_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val matches:Boolean = new Boolean() with get,set
        member val legacy_succeeded:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val composed_succeeded:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val differences:String = null with get,set
        member val request_summary_json:String = null with get,set
        member val legacy_summary_json:String = null with get,set
        member val composed_summary_json:String = null with get,set

    [<AllowNullLiteral>]
    type RegistrationBillingCompletenessAuditResponse() = 
        member val transaction_id:Int32 = new Int32() with get,set
        member val transaction_uuid:String = null with get,set
        member val reporting_term:String = null with get,set
        member val finished_datetime:DateTime = new DateTime() with get,set
        member val operation:String = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val student_uuid:String = null with get,set
        member val student_name:String = null with get,set
        member val invoice_count:Int32 = new Int32() with get,set
        member val invoice_net:Decimal = new Decimal() with get,set
        member val item_net:Decimal = new Decimal() with get,set
        member val gp_success_count:Int32 = new Int32() with get,set
        member val gp_failure_count:Int32 = new Int32() with get,set
        member val calculation_status:String = null with get,set
        member val calculation_findings:String = null with get,set
        member val status:String = null with get,set
        member val findings:String = null with get,set
        member val resolved_datetime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val resolved_by_uuid:String = null with get,set

    [<AllowNullLiteral>]
    type RegistrationBillingFailureAuditResponse() = 
        member val source:String = null with get,set
        member val reporting_term:String = null with get,set
        member val id:Int64 = new Int64() with get,set
        member val timestamp:DateTime = new DateTime() with get,set
        member val workflow:String = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val transaction_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val invoice_id:String = null with get,set
        member val gp_document_number:String = null with get,set
        member val amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val error:String = null with get,set

    [<AllowNullLiteral>]
    type RegistrationBillingDriftAuditResponse() = 
        member val transaction_id:Int32 = new Int32() with get,set
        member val reporting_term:String = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val workflow:String = null with get,set
        member val calculation_count:Int32 = new Int32() with get,set
        member val first_calculation:DateTime = new DateTime() with get,set
        member val final_calculation:DateTime = new DateTime() with get,set
        member val changed:Boolean = new Boolean() with get,set
        member val persistence_status:String = null with get,set
        member val persistence_findings:String = null with get,set
        member val first_summary_json:String = null with get,set
        member val final_summary_json:String = null with get,set
        member val section_course_codes:Dictionary<Int32, String> = new Dictionary<Int32, String>() with get,set

    [<AllowNullLiteral>]
    type RegistrationBillingAuditReportResponse() = 
        member val parity:ResizeArray<RegistrationBillingParityAuditResponse> = new ResizeArray<RegistrationBillingParityAuditResponse>() with get,set
        member val completeness:ResizeArray<RegistrationBillingCompletenessAuditResponse> = new ResizeArray<RegistrationBillingCompletenessAuditResponse>() with get,set
        member val failures:ResizeArray<RegistrationBillingFailureAuditResponse> = new ResizeArray<RegistrationBillingFailureAuditResponse>() with get,set
        member val drift:ResizeArray<RegistrationBillingDriftAuditResponse> = new ResizeArray<RegistrationBillingDriftAuditResponse>() with get,set

    [<AllowNullLiteral>]
    type RegistrationBillingAuditReportRequest() = 
        member val reporting_term:String = null with get,set
        member val from_date:DateTime = new DateTime() with get,set
        member val to_date:DateTime = new DateTime() with get,set
        member val authorizing_uuid:String = null with get,set

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