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
import Foundation
import ServiceStack

public class RegistrationBillingAuditReportRequest : Codable
{
    public var reporting_term:String
    public var from_date:Date
    public var to_date:Date
    public var authorizing_uuid:String

    required public init(){}
}

public class RegistrationBillingAuditReportResponse : Codable
{
    public var parity:[RegistrationBillingParityAuditResponse] = []
    public var completeness:[RegistrationBillingCompletenessAuditResponse] = []
    public var failures:[RegistrationBillingFailureAuditResponse] = []
    public var drift:[RegistrationBillingDriftAuditResponse] = []

    required public init(){}
}

public class RegistrationBillingParityAuditResponse : Codable
{
    public var execution_id:Int
    public var reporting_term:String
    public var timestamp:Date
    public var workflow:String
    public var execution_mode:String
    public var regent_id:Int
    public var transaction_id:Int?
    public var matches:Bool
    public var legacy_succeeded:Bool?
    public var composed_succeeded:Bool?
    public var differences:String
    public var request_summary_json:String
    public var legacy_summary_json:String
    public var composed_summary_json:String

    required public init(){}
}

public class RegistrationBillingCompletenessAuditResponse : Codable
{
    public var transaction_id:Int
    public var transaction_uuid:String
    public var reporting_term:String
    public var finished_datetime:Date
    public var operation:String
    public var regent_id:Int
    public var student_uuid:String
    public var student_name:String
    public var invoice_count:Int
    public var invoice_net:Double
    public var item_net:Double
    public var gp_success_count:Int
    public var gp_failure_count:Int
    public var calculation_status:String
    public var calculation_findings:String
    public var status:String
    public var findings:String
    public var resolved_datetime:Date?
    public var resolved_by_uuid:String

    required public init(){}
}

public class RegistrationBillingFailureAuditResponse : Codable
{
    public var source:String
    public var reporting_term:String
    public var id:Int
    public var timestamp:Date
    public var workflow:String
    public var regent_id:Int
    public var transaction_id:Int?
    public var invoice_id:String
    public var gp_document_number:String
    public var amount:Double?
    public var error:String

    required public init(){}
}

public class RegistrationBillingDriftAuditResponse : Codable
{
    public var transaction_id:Int
    public var reporting_term:String
    public var regent_id:Int
    public var workflow:String
    public var calculation_count:Int
    public var first_calculation:Date
    public var final_calculation:Date
    public var changed:Bool
    public var persistence_status:String
    public var persistence_findings:String
    public var first_summary_json:String
    public var final_summary_json:String
    public var section_course_codes:[Int:String] = [:]

    required public init(){}
}


Swift RegistrationBillingAuditReportRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<RegistrationBillingAuditReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <from_date>0001-01-01T00:00:00</from_date>
  <reporting_term>String</reporting_term>
  <to_date>0001-01-01T00:00:00</to_date>
</RegistrationBillingAuditReportRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegistrationBillingAuditReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <completeness>
    <RegistrationBillingCompletenessAuditResponse>
      <calculation_findings>String</calculation_findings>
      <calculation_status>String</calculation_status>
      <findings>String</findings>
      <finished_datetime>0001-01-01T00:00:00</finished_datetime>
      <gp_failure_count>0</gp_failure_count>
      <gp_success_count>0</gp_success_count>
      <invoice_count>0</invoice_count>
      <invoice_net>0</invoice_net>
      <item_net>0</item_net>
      <operation>String</operation>
      <regent_id>0</regent_id>
      <reporting_term>String</reporting_term>
      <resolved_by_uuid>String</resolved_by_uuid>
      <resolved_datetime>0001-01-01T00:00:00</resolved_datetime>
      <status>String</status>
      <student_name>String</student_name>
      <student_uuid>String</student_uuid>
      <transaction_id>0</transaction_id>
      <transaction_uuid>String</transaction_uuid>
    </RegistrationBillingCompletenessAuditResponse>
  </completeness>
  <drift>
    <RegistrationBillingDriftAuditResponse>
      <calculation_count>0</calculation_count>
      <changed>false</changed>
      <final_calculation>0001-01-01T00:00:00</final_calculation>
      <final_summary_json>String</final_summary_json>
      <first_calculation>0001-01-01T00:00:00</first_calculation>
      <first_summary_json>String</first_summary_json>
      <persistence_findings>String</persistence_findings>
      <persistence_status>String</persistence_status>
      <regent_id>0</regent_id>
      <reporting_term>String</reporting_term>
      <section_course_codes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfintstring>
          <d4p1:Key>0</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfintstring>
      </section_course_codes>
      <transaction_id>0</transaction_id>
      <workflow>String</workflow>
    </RegistrationBillingDriftAuditResponse>
  </drift>
  <failures>
    <RegistrationBillingFailureAuditResponse>
      <amount>0</amount>
      <error>String</error>
      <gp_document_number>String</gp_document_number>
      <id>0</id>
      <invoice_id>String</invoice_id>
      <regent_id>0</regent_id>
      <reporting_term>String</reporting_term>
      <source>String</source>
      <timestamp>0001-01-01T00:00:00</timestamp>
      <transaction_id>0</transaction_id>
      <workflow>String</workflow>
    </RegistrationBillingFailureAuditResponse>
  </failures>
  <parity>
    <RegistrationBillingParityAuditResponse>
      <composed_succeeded>false</composed_succeeded>
      <composed_summary_json>String</composed_summary_json>
      <differences>String</differences>
      <execution_id>0</execution_id>
      <execution_mode>String</execution_mode>
      <legacy_succeeded>false</legacy_succeeded>
      <legacy_summary_json>String</legacy_summary_json>
      <matches>false</matches>
      <regent_id>0</regent_id>
      <reporting_term>String</reporting_term>
      <request_summary_json>String</request_summary_json>
      <timestamp>0001-01-01T00:00:00</timestamp>
      <transaction_id>0</transaction_id>
      <workflow>String</workflow>
    </RegistrationBillingParityAuditResponse>
  </parity>
</RegistrationBillingAuditReportResponse>