regis

DropRegistrationsBillingPlanPreviewRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Registration/{uuid}/Drop/{reporting_term}/BillingPlanPreview

import Foundation
import ServiceStack

public class DropRegistrationsBillingPlanPreviewRequest : Codable
{
    public var transaction_uuid:String
    public var uuid:String
    public var reporting_term:String
    public var registrations:[DropRegistrationSubmitRequest] = []
    public var Description:String
    public var drop_fee:Double?
    public var drop_description:String
    public var refund_student_fees:Bool
    public var authorizing_uuid:String

    required public init(){}
}

public class DropRegistrationSubmitRequest : Codable
{
    public var student_section_uuid:String
    public var tuition_refund_amount:Double
    public var Description:String
    public var additional_rate_id:Int?
    public var additional_rate_amount:Double?
    public var benefit_rate_id:Int?
    public var second_benefit_rate_id:Int?
    public var benefit_charge_amount:Double?
    public var second_benefit_charge_amount:Double?

    required public init(){}
}

public class RegistrationBillingPlanResponse : Codable
{
    public var transaction_uuid:String
    public var uuid:String
    public var regent_id:Int
    public var reporting_term:String
    public var total_charges:Double?
    public var total_credits:Double?
    public var terms:[RegistrationBillingPlanTermResponse] = []

    required public init(){}
}

public class RegistrationBillingPlanTermResponse : Codable
{
    public var reporting_term:String
    public var term_name:String
    public var due_date:Date?
    public var total_charges:Double?
    public var total_credits:Double?
    public var invoiceItemGroups:[RegistrationBillingPlanInvoiceItemGroupResponse] = []

    required public init(){}
}

public class RegistrationBillingPlanInvoiceItemGroupResponse : Codable
{
    public var name:String
    public var Description:String
    public var rate_code:String
    public var rate_description:String
    public var total_charges:Double?
    public var total_credits:Double?
    public var studentSectionInvoiceItems:[StudentSectionInvoiceItemResponse] = []
    public var invoiceItems:[InvoiceItemResponse] = []
    public var otherInvoiceItems:[InvoiceItemResponse] = []

    required public init(){}
}

public class StudentSectionInvoiceItemResponse : InvoiceItemResponse
{
    public var studentSection:StudentSectionResponse

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case studentSection
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        studentSection = try container.decodeIfPresent(StudentSectionResponse.self, forKey: .studentSection)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if studentSection != nil { try container.encode(studentSection, forKey: .studentSection) }
    }
}

public class InvoiceItemResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var invoiceItemUUID:String
    public var rate_id:Int
    public var rate_code:String
    public var rate_description:String
    public var reporting_term:String
    public var charge:Double?
    public var credit:Double?

    required public init(){}
}

public class StudentSectionResponse : SectionResponse
{
    public var studentSectionUUID:String
    public var registered_amount:Double
    public var is_provisional:Bool
    public var is_audit:Bool

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case studentSectionUUID
        case registered_amount
        case is_provisional
        case is_audit
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        studentSectionUUID = try container.decodeIfPresent(String.self, forKey: .studentSectionUUID)
        registered_amount = try container.decodeIfPresent(Double.self, forKey: .registered_amount)
        is_provisional = try container.decodeIfPresent(Bool.self, forKey: .is_provisional)
        is_audit = try container.decodeIfPresent(Bool.self, forKey: .is_audit)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if studentSectionUUID != nil { try container.encode(studentSectionUUID, forKey: .studentSectionUUID) }
        if registered_amount != nil { try container.encode(registered_amount, forKey: .registered_amount) }
        if is_provisional != nil { try container.encode(is_provisional, forKey: .is_provisional) }
        if is_audit != nil { try container.encode(is_audit, forKey: .is_audit) }
    }
}

public class SectionResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var secUUID:String
    public var course_name:String
    public var section_code:String
    public var course_title:String
    public var course_short_title:String
    public var course_description:String
    public var crosslist_description:String
    public var crosslist_course_name:String
    public var location_long_name:String
    public var room:String
    public var instructors:[InstructorResponse] = []
    public var required_documents:[DocumentResponse] = []
    public var start_date:Date?
    public var end_date:Date?
    public var first_meeting_date:Date?
    public var last_meeting_date:Date?
    public var meeting_days:String
    public var start_times:[String] = []
    public var end_times:[String] = []
    public var is_online_only:Bool
    public var is_weekend:Bool
    public var is_weekday:Bool
    public var is_evening:Bool
    public var is_waitlist:Bool
    public var has_special_requirements:Bool
    public var special_requirements:String
    public var is_unlisted:Bool
    public var credit_amounts:[Double] = []
    public var audit_amounts:[Double] = []
    public var audits_short_name:String
    public var audits_long_name:String
    public var credits_short_name:String
    public var credits_long_name:String
    public var distance_ed_materials:String
    public var prerequisites:String
    public var corequisites:String
    public var capacity:Int?
    public var flat_fee_amount:Double?
    public var additional_fee_amount:Double?
    public var registered_students:Int
    public var three_credit_plus:Int
    public var two_credit:Int
    public var one_credit:Int
    public var three_audit_plus:Int
    public var two_audit:Int
    public var one_audit:Int
    public var crosslist_registered_students:Int
    public var grades_received:Int
    public var crosslist_grades_received:Int
    public var registration_start_date:Date?
    public var registration_end_date:Date?
    public var add_start_date:Date?
    public var add_end_date:Date?
    public var drop_start_date:Date?
    public var drop_end_date:Date?
    public var grading_end_date:Date?
    public var term:String
    public var reporting_term:String
    public var reporting_year:Int
    public var current_status:String
    public var added_by:String
    public var added_date:Date?
    public var changed_by:String
    public var changed_date:Date?
    public var timestamp:Date

    required public init(){}
}

public class InstructorResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var regent_login:String
    public var preferred_name:String
    public var first_name:String
    public var last_name:String
    public var full_name:String
    public var email:String
    public var image_base64:String

    required public init(){}
}

public class DocumentResponse : Codable
{
    public var code:String
    public var document_name:String
    public var document_description:String

    required public init(){}
}

Swift DropRegistrationsBillingPlanPreviewRequest 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/{uuid}/Drop/{reporting_term}/BillingPlanPreview HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DropRegistrationsBillingPlanPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <description>String</description>
  <drop_description>String</drop_description>
  <drop_fee>0</drop_fee>
  <refund_student_fees>false</refund_student_fees>
  <registrations>
    <DropRegistrationSubmitRequest>
      <additional_rate_amount>0</additional_rate_amount>
      <additional_rate_id>0</additional_rate_id>
      <benefit_charge_amount>0</benefit_charge_amount>
      <benefit_rate_id>0</benefit_rate_id>
      <description>String</description>
      <second_benefit_charge_amount>0</second_benefit_charge_amount>
      <second_benefit_rate_id>0</second_benefit_rate_id>
      <student_section_uuid>String</student_section_uuid>
      <tuition_refund_amount>0</tuition_refund_amount>
    </DropRegistrationSubmitRequest>
  </registrations>
  <reporting_term>String</reporting_term>
  <transaction_uuid>String</transaction_uuid>
  <uuid>String</uuid>
</DropRegistrationsBillingPlanPreviewRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegistrationBillingPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <regent_id>0</regent_id>
  <reporting_term>String</reporting_term>
  <terms>
    <RegistrationBillingPlanTermResponse>
      <due_date>0001-01-01T00:00:00</due_date>
      <invoiceItemGroups>
        <RegistrationBillingPlanInvoiceItemGroupResponse>
          <description>String</description>
          <invoiceItems>
            <InvoiceItemResponse>
              <ResponseStatus xmlns:d8p1="http://schemas.servicestack.net/types">
                <d8p1:ErrorCode>String</d8p1:ErrorCode>
                <d8p1:Message>String</d8p1:Message>
                <d8p1:StackTrace>String</d8p1:StackTrace>
                <d8p1:Errors>
                  <d8p1:ResponseError>
                    <d8p1:ErrorCode>String</d8p1:ErrorCode>
                    <d8p1:FieldName>String</d8p1:FieldName>
                    <d8p1:Message>String</d8p1:Message>
                    <d8p1:Meta xmlns:d11p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                      <d11p1:KeyValueOfstringstring>
                        <d11p1:Key>String</d11p1:Key>
                        <d11p1:Value>String</d11p1:Value>
                      </d11p1:KeyValueOfstringstring>
                    </d8p1:Meta>
                  </d8p1:ResponseError>
                </d8p1:Errors>
                <d8p1:Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:KeyValueOfstringstring>
                    <d9p1:Key>String</d9p1:Key>
                    <d9p1:Value>String</d9p1:Value>
                  </d9p1:KeyValueOfstringstring>
                </d8p1:Meta>
              </ResponseStatus>
              <charge>0</charge>
              <credit>0</credit>
              <invoiceItemUUID>String</invoiceItemUUID>
              <rate_code>String</rate_code>
              <rate_description>String</rate_description>
              <rate_id>0</rate_id>
              <reporting_term>String</reporting_term>
            </InvoiceItemResponse>
          </invoiceItems>
          <name>String</name>
          <otherInvoiceItems>
            <InvoiceItemResponse>
              <ResponseStatus xmlns:d8p1="http://schemas.servicestack.net/types">
                <d8p1:ErrorCode>String</d8p1:ErrorCode>
                <d8p1:Message>String</d8p1:Message>
                <d8p1:StackTrace>String</d8p1:StackTrace>
                <d8p1:Errors>
                  <d8p1:ResponseError>
                    <d8p1:ErrorCode>String</d8p1:ErrorCode>
                    <d8p1:FieldName>String</d8p1:FieldName>
                    <d8p1:Message>String</d8p1:Message>
                    <d8p1:Meta xmlns:d11p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                      <d11p1:KeyValueOfstringstring>
                        <d11p1:Key>String</d11p1:Key>
                        <d11p1:Value>String</d11p1:Value>
                      </d11p1:KeyValueOfstringstring>
                    </d8p1:Meta>
                  </d8p1:ResponseError>
                </d8p1:Errors>
                <d8p1:Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:KeyValueOfstringstring>
                    <d9p1:Key>String</d9p1:Key>
                    <d9p1:Value>String</d9p1:Value>
                  </d9p1:KeyValueOfstringstring>
                </d8p1:Meta>
              </ResponseStatus>
              <charge>0</charge>
              <credit>0</credit>
              <invoiceItemUUID>String</invoiceItemUUID>
              <rate_code>String</rate_code>
              <rate_description>String</rate_description>
              <rate_id>0</rate_id>
              <reporting_term>String</reporting_term>
            </InvoiceItemResponse>
          </otherInvoiceItems>
          <rate_code>String</rate_code>
          <rate_description>String</rate_description>
          <studentSectionInvoiceItems>
            <StudentSectionInvoiceItemResponse>
              <ResponseStatus xmlns:d8p1="http://schemas.servicestack.net/types">
                <d8p1:ErrorCode>String</d8p1:ErrorCode>
                <d8p1:Message>String</d8p1:Message>
                <d8p1:StackTrace>String</d8p1:StackTrace>
                <d8p1:Errors>
                  <d8p1:ResponseError>
                    <d8p1:ErrorCode>String</d8p1:ErrorCode>
                    <d8p1:FieldName>String</d8p1:FieldName>
                    <d8p1:Message>String</d8p1:Message>
                    <d8p1:Meta xmlns:d11p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                      <d11p1:KeyValueOfstringstring>
                        <d11p1:Key>String</d11p1:Key>
                        <d11p1:Value>String</d11p1:Value>
                      </d11p1:KeyValueOfstringstring>
                    </d8p1:Meta>
                  </d8p1:ResponseError>
                </d8p1:Errors>
                <d8p1:Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:KeyValueOfstringstring>
                    <d9p1:Key>String</d9p1:Key>
                    <d9p1:Value>String</d9p1:Value>
                  </d9p1:KeyValueOfstringstring>
                </d8p1:Meta>
              </ResponseStatus>
              <charge>0</charge>
              <credit>0</credit>
              <invoiceItemUUID>String</invoiceItemUUID>
              <rate_code>String</rate_code>
              <rate_description>String</rate_description>
              <rate_id>0</rate_id>
              <reporting_term>String</reporting_term>
              <studentSection>
                <ResponseStatus xmlns:d9p1="http://schemas.servicestack.net/types">
                  <d9p1:ErrorCode>String</d9p1:ErrorCode>
                  <d9p1:Message>String</d9p1:Message>
                  <d9p1:StackTrace>String</d9p1:StackTrace>
                  <d9p1:Errors>
                    <d9p1:ResponseError>
                      <d9p1:ErrorCode>String</d9p1:ErrorCode>
                      <d9p1:FieldName>String</d9p1:FieldName>
                      <d9p1:Message>String</d9p1:Message>
                      <d9p1:Meta xmlns:d12p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                        <d12p1:KeyValueOfstringstring>
                          <d12p1:Key>String</d12p1:Key>
                          <d12p1:Value>String</d12p1:Value>
                        </d12p1:KeyValueOfstringstring>
                      </d9p1:Meta>
                    </d9p1:ResponseError>
                  </d9p1:Errors>
                  <d9p1:Meta xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:KeyValueOfstringstring>
                      <d10p1:Key>String</d10p1:Key>
                      <d10p1:Value>String</d10p1:Value>
                    </d10p1:KeyValueOfstringstring>
                  </d9p1:Meta>
                </ResponseStatus>
                <add_end_date>0001-01-01T00:00:00</add_end_date>
                <add_start_date>0001-01-01T00:00:00</add_start_date>
                <added_by>String</added_by>
                <added_date>0001-01-01T00:00:00</added_date>
                <additional_fee_amount>0</additional_fee_amount>
                <audit_amounts xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:decimal>0</d9p1:decimal>
                </audit_amounts>
                <audits_long_name>String</audits_long_name>
                <audits_short_name>String</audits_short_name>
                <capacity>0</capacity>
                <changed_by>String</changed_by>
                <changed_date>0001-01-01T00:00:00</changed_date>
                <corequisites>String</corequisites>
                <course_description>String</course_description>
                <course_name>String</course_name>
                <course_short_title>String</course_short_title>
                <course_title>String</course_title>
                <credit_amounts xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:decimal>0</d9p1:decimal>
                </credit_amounts>
                <credits_long_name>String</credits_long_name>
                <credits_short_name>String</credits_short_name>
                <crosslist_course_name>String</crosslist_course_name>
                <crosslist_description>String</crosslist_description>
                <crosslist_grades_received>0</crosslist_grades_received>
                <crosslist_registered_students>0</crosslist_registered_students>
                <current_status>String</current_status>
                <distance_ed_materials>String</distance_ed_materials>
                <drop_end_date>0001-01-01T00:00:00</drop_end_date>
                <drop_start_date>0001-01-01T00:00:00</drop_start_date>
                <end_date>0001-01-01T00:00:00</end_date>
                <end_times xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:string>String</d9p1:string>
                </end_times>
                <first_meeting_date>0001-01-01T00:00:00</first_meeting_date>
                <flat_fee_amount>0</flat_fee_amount>
                <grades_received>0</grades_received>
                <grading_end_date>0001-01-01T00:00:00</grading_end_date>
                <has_special_requirements>false</has_special_requirements>
                <instructors>
                  <InstructorResponse>
                    <ResponseStatus xmlns:d11p1="http://schemas.servicestack.net/types">
                      <d11p1:ErrorCode>String</d11p1:ErrorCode>
                      <d11p1:Message>String</d11p1:Message>
                      <d11p1:StackTrace>String</d11p1:StackTrace>
                      <d11p1:Errors>
                        <d11p1:ResponseError>
                          <d11p1:ErrorCode>String</d11p1:ErrorCode>
                          <d11p1:FieldName>String</d11p1:FieldName>
                          <d11p1:Message>String</d11p1:Message>
                          <d11p1:Meta xmlns:d14p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                            <d14p1:KeyValueOfstringstring>
                              <d14p1:Key>String</d14p1:Key>
                              <d14p1:Value>String</d14p1:Value>
                            </d14p1:KeyValueOfstringstring>
                          </d11p1:Meta>
                        </d11p1:ResponseError>
                      </d11p1:Errors>
                      <d11p1:Meta xmlns:d12p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                        <d12p1:KeyValueOfstringstring>
                          <d12p1:Key>String</d12p1:Key>
                          <d12p1:Value>String</d12p1:Value>
                        </d12p1:KeyValueOfstringstring>
                      </d11p1:Meta>
                    </ResponseStatus>
                    <email>String</email>
                    <first_name>String</first_name>
                    <full_name>String</full_name>
                    <image_base64>String</image_base64>
                    <last_name>String</last_name>
                    <preferred_name>String</preferred_name>
                    <regent_id>0</regent_id>
                    <regent_login>String</regent_login>
                  </InstructorResponse>
                </instructors>
                <is_evening>false</is_evening>
                <is_online_only>false</is_online_only>
                <is_unlisted>false</is_unlisted>
                <is_waitlist>false</is_waitlist>
                <is_weekday>false</is_weekday>
                <is_weekend>false</is_weekend>
                <last_meeting_date>0001-01-01T00:00:00</last_meeting_date>
                <location_long_name>String</location_long_name>
                <meeting_days>String</meeting_days>
                <one_audit>0</one_audit>
                <one_credit>0</one_credit>
                <prerequisites>String</prerequisites>
                <registered_students>0</registered_students>
                <registration_end_date>0001-01-01T00:00:00</registration_end_date>
                <registration_start_date>0001-01-01T00:00:00</registration_start_date>
                <reporting_term>String</reporting_term>
                <reporting_year>0</reporting_year>
                <required_documents>
                  <DocumentResponse>
                    <code>String</code>
                    <document_description>String</document_description>
                    <document_name>String</document_name>
                  </DocumentResponse>
                </required_documents>
                <room>String</room>
                <secUUID>String</secUUID>
                <section_code>String</section_code>
                <special_requirements>String</special_requirements>
                <start_date>0001-01-01T00:00:00</start_date>
                <start_times xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:string>String</d9p1:string>
                </start_times>
                <term>String</term>
                <three_audit_plus>0</three_audit_plus>
                <three_credit_plus>0</three_credit_plus>
                <timestamp>0001-01-01T00:00:00</timestamp>
                <two_audit>0</two_audit>
                <two_credit>0</two_credit>
                <is_audit>false</is_audit>
                <is_provisional>false</is_provisional>
                <registered_amount>0</registered_amount>
                <studentSectionUUID>String</studentSectionUUID>
              </studentSection>
            </StudentSectionInvoiceItemResponse>
          </studentSectionInvoiceItems>
          <total_charges>0</total_charges>
          <total_credits>0</total_credits>
        </RegistrationBillingPlanInvoiceItemGroupResponse>
      </invoiceItemGroups>
      <reporting_term>String</reporting_term>
      <term_name>String</term_name>
      <total_charges>0</total_charges>
      <total_credits>0</total_credits>
    </RegistrationBillingPlanTermResponse>
  </terms>
  <total_charges>0</total_charges>
  <total_credits>0</total_credits>
  <transaction_uuid>String</transaction_uuid>
  <uuid>String</uuid>
</RegistrationBillingPlanResponse>