regis

DropRegistrationsBillingPlanPreviewRequest

**Requires Authentication**
Required role:	REGISUserRole

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

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 DropRegistrationsBillingPlanPreviewRequest
    {
        public DropRegistrationsBillingPlanPreviewRequest()
        {
            registrations = new List<DropRegistrationSubmitRequest>{};
        }

        public virtual string transaction_uuid { get; set; }
        public virtual string uuid { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual List<DropRegistrationSubmitRequest> registrations { get; set; }
        public virtual string description { get; set; }
        public virtual decimal? drop_fee { get; set; }
        public virtual string drop_description { get; set; }
        public virtual bool refund_student_fees { get; set; }
        public virtual string authorizing_uuid { get; set; }
    }

    public partial class DropRegistrationSubmitRequest
    {
        public virtual string student_section_uuid { get; set; }
        public virtual decimal tuition_refund_amount { get; set; }
        public virtual string description { get; set; }
        public virtual int? additional_rate_id { get; set; }
        public virtual decimal? additional_rate_amount { get; set; }
        public virtual int? benefit_rate_id { get; set; }
        public virtual int? second_benefit_rate_id { get; set; }
        public virtual decimal? benefit_charge_amount { get; set; }
        public virtual decimal? second_benefit_charge_amount { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class DocumentResponse
    {
        public virtual string code { get; set; }
        public virtual string document_name { get; set; }
        public virtual string document_description { get; set; }
    }

    public partial class InstructorResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string regent_login { get; set; }
        public virtual string preferred_name { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string full_name { get; set; }
        public virtual string email { get; set; }
        public virtual string image_base64 { get; set; }
    }

    public partial class InvoiceItemResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string invoiceItemUUID { get; set; }
        public virtual int rate_id { get; set; }
        public virtual string rate_code { get; set; }
        public virtual string rate_description { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual decimal? charge { get; set; }
        public virtual decimal? credit { get; set; }
    }

    public partial class RegistrationBillingPlanInvoiceItemGroupResponse
    {
        public RegistrationBillingPlanInvoiceItemGroupResponse()
        {
            studentSectionInvoiceItems = new List<StudentSectionInvoiceItemResponse>{};
            invoiceItems = new List<InvoiceItemResponse>{};
            otherInvoiceItems = new List<InvoiceItemResponse>{};
        }

        public virtual string name { get; set; }
        public virtual string description { get; set; }
        public virtual string rate_code { get; set; }
        public virtual string rate_description { get; set; }
        public virtual decimal? total_charges { get; set; }
        public virtual decimal? total_credits { get; set; }
        public virtual List<StudentSectionInvoiceItemResponse> studentSectionInvoiceItems { get; set; }
        public virtual List<InvoiceItemResponse> invoiceItems { get; set; }
        public virtual List<InvoiceItemResponse> otherInvoiceItems { get; set; }
    }

    public partial class RegistrationBillingPlanResponse
    {
        public RegistrationBillingPlanResponse()
        {
            terms = new List<RegistrationBillingPlanTermResponse>{};
        }

        public virtual string transaction_uuid { get; set; }
        public virtual string uuid { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual decimal? total_charges { get; set; }
        public virtual decimal? total_credits { get; set; }
        public virtual List<RegistrationBillingPlanTermResponse> terms { get; set; }
    }

    public partial class RegistrationBillingPlanTermResponse
    {
        public RegistrationBillingPlanTermResponse()
        {
            invoiceItemGroups = new List<RegistrationBillingPlanInvoiceItemGroupResponse>{};
        }

        public virtual string reporting_term { get; set; }
        public virtual string term_name { get; set; }
        public virtual DateTime? due_date { get; set; }
        public virtual decimal? total_charges { get; set; }
        public virtual decimal? total_credits { get; set; }
        public virtual List<RegistrationBillingPlanInvoiceItemGroupResponse> invoiceItemGroups { get; set; }
    }

    public partial class SectionResponse
    {
        public SectionResponse()
        {
            instructors = new List<InstructorResponse>{};
            required_documents = new List<DocumentResponse>{};
            start_times = new List<string>{};
            end_times = new List<string>{};
            credit_amounts = new List<decimal>{};
            audit_amounts = new List<decimal>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string secUUID { get; set; }
        public virtual string course_name { get; set; }
        public virtual string section_code { get; set; }
        public virtual string course_title { get; set; }
        public virtual string course_short_title { get; set; }
        public virtual string course_description { get; set; }
        public virtual string crosslist_description { get; set; }
        public virtual string crosslist_course_name { get; set; }
        public virtual string location_long_name { get; set; }
        public virtual string room { get; set; }
        public virtual List<InstructorResponse> instructors { get; set; }
        public virtual List<DocumentResponse> required_documents { get; set; }
        public virtual DateTime? start_date { get; set; }
        public virtual DateTime? end_date { get; set; }
        public virtual DateTime? first_meeting_date { get; set; }
        public virtual DateTime? last_meeting_date { get; set; }
        public virtual string meeting_days { get; set; }
        public virtual List<string> start_times { get; set; }
        public virtual List<string> end_times { get; set; }
        public virtual bool is_online_only { get; set; }
        public virtual bool is_weekend { get; set; }
        public virtual bool is_weekday { get; set; }
        public virtual bool is_evening { get; set; }
        public virtual bool is_waitlist { get; set; }
        public virtual bool has_special_requirements { get; set; }
        public virtual string special_requirements { get; set; }
        public virtual bool is_unlisted { get; set; }
        public virtual List<decimal> credit_amounts { get; set; }
        public virtual List<decimal> audit_amounts { get; set; }
        public virtual string audits_short_name { get; set; }
        public virtual string audits_long_name { get; set; }
        public virtual string credits_short_name { get; set; }
        public virtual string credits_long_name { get; set; }
        public virtual string distance_ed_materials { get; set; }
        public virtual string prerequisites { get; set; }
        public virtual string corequisites { get; set; }
        public virtual int? capacity { get; set; }
        public virtual decimal? flat_fee_amount { get; set; }
        public virtual decimal? additional_fee_amount { get; set; }
        public virtual int registered_students { get; set; }
        public virtual int three_credit_plus { get; set; }
        public virtual int two_credit { get; set; }
        public virtual int one_credit { get; set; }
        public virtual int three_audit_plus { get; set; }
        public virtual int two_audit { get; set; }
        public virtual int one_audit { get; set; }
        public virtual int crosslist_registered_students { get; set; }
        public virtual int grades_received { get; set; }
        public virtual int crosslist_grades_received { get; set; }
        public virtual DateTime? registration_start_date { get; set; }
        public virtual DateTime? registration_end_date { get; set; }
        public virtual DateTime? add_start_date { get; set; }
        public virtual DateTime? add_end_date { get; set; }
        public virtual DateTime? drop_start_date { get; set; }
        public virtual DateTime? drop_end_date { get; set; }
        public virtual DateTime? grading_end_date { get; set; }
        public virtual string term { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual int reporting_year { get; set; }
        public virtual string current_status { get; set; }
        public virtual string added_by { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual string changed_by { get; set; }
        public virtual DateTime? changed_date { get; set; }
        public virtual DateTime timestamp { get; set; }
    }

    public partial class StudentSectionInvoiceItemResponse
        : InvoiceItemResponse
    {
        public virtual StudentSectionResponse studentSection { get; set; }
    }

    public partial class StudentSectionResponse
        : SectionResponse
    {
        public virtual string studentSectionUUID { get; set; }
        public virtual decimal registered_amount { get; set; }
        public virtual bool is_provisional { get; set; }
        public virtual bool is_audit { get; set; }
    }

}

C# 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>