| Required role: | REGISUserRole |
| POST | /Registration/{uuid}/Drop/{reporting_term}/BillingPlanPreview |
|---|
namespace regis.ClassLibrary.Requests
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type InvoiceItemResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val invoiceItemUUID:String = null with get,set
member val rate_id:Int32 = new Int32() with get,set
member val rate_code:String = null with get,set
member val rate_description:String = null with get,set
member val reporting_term:String = null with get,set
member val charge:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val credit:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<AllowNullLiteral>]
type InstructorResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val regent_id:Int32 = new Int32() with get,set
member val regent_login:String = null with get,set
member val preferred_name:String = null with get,set
member val first_name:String = null with get,set
member val last_name:String = null with get,set
member val full_name:String = null with get,set
member val email:String = null with get,set
member val image_base64:String = null with get,set
[<AllowNullLiteral>]
type DocumentResponse() =
member val code:String = null with get,set
member val document_name:String = null with get,set
member val document_description:String = null with get,set
[<AllowNullLiteral>]
type SectionResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val secUUID:String = null with get,set
member val course_name:String = null with get,set
member val section_code:String = null with get,set
member val course_title:String = null with get,set
member val course_short_title:String = null with get,set
member val course_description:String = null with get,set
member val crosslist_description:String = null with get,set
member val crosslist_course_name:String = null with get,set
member val location_long_name:String = null with get,set
member val room:String = null with get,set
member val instructors:ResizeArray<InstructorResponse> = new ResizeArray<InstructorResponse>() with get,set
member val required_documents:ResizeArray<DocumentResponse> = new ResizeArray<DocumentResponse>() with get,set
member val start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val first_meeting_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val last_meeting_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val meeting_days:String = null with get,set
member val start_times:ResizeArray<String> = new ResizeArray<String>() with get,set
member val end_times:ResizeArray<String> = new ResizeArray<String>() with get,set
member val is_online_only:Boolean = new Boolean() with get,set
member val is_weekend:Boolean = new Boolean() with get,set
member val is_weekday:Boolean = new Boolean() with get,set
member val is_evening:Boolean = new Boolean() with get,set
member val is_waitlist:Boolean = new Boolean() with get,set
member val has_special_requirements:Boolean = new Boolean() with get,set
member val special_requirements:String = null with get,set
member val is_unlisted:Boolean = new Boolean() with get,set
member val credit_amounts:ResizeArray<Decimal> = new ResizeArray<Decimal>() with get,set
member val audit_amounts:ResizeArray<Decimal> = new ResizeArray<Decimal>() with get,set
member val audits_short_name:String = null with get,set
member val audits_long_name:String = null with get,set
member val credits_short_name:String = null with get,set
member val credits_long_name:String = null with get,set
member val distance_ed_materials:String = null with get,set
member val prerequisites:String = null with get,set
member val corequisites:String = null with get,set
member val capacity:Nullable<Int32> = new Nullable<Int32>() with get,set
member val flat_fee_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val additional_fee_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val registered_students:Int32 = new Int32() with get,set
member val three_credit_plus:Int32 = new Int32() with get,set
member val two_credit:Int32 = new Int32() with get,set
member val one_credit:Int32 = new Int32() with get,set
member val three_audit_plus:Int32 = new Int32() with get,set
member val two_audit:Int32 = new Int32() with get,set
member val one_audit:Int32 = new Int32() with get,set
member val crosslist_registered_students:Int32 = new Int32() with get,set
member val grades_received:Int32 = new Int32() with get,set
member val crosslist_grades_received:Int32 = new Int32() with get,set
member val registration_start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val registration_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val add_start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val add_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val drop_start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val drop_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val grading_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val term:String = null with get,set
member val reporting_term:String = null with get,set
member val reporting_year:Int32 = new Int32() with get,set
member val current_status:String = null with get,set
member val added_by:String = null with get,set
member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val changed_by:String = null with get,set
member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val timestamp:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type StudentSectionResponse() =
inherit SectionResponse()
member val studentSectionUUID:String = null with get,set
member val registered_amount:Decimal = new Decimal() with get,set
member val is_provisional:Boolean = new Boolean() with get,set
member val is_audit:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type StudentSectionInvoiceItemResponse() =
inherit InvoiceItemResponse()
member val studentSection:StudentSectionResponse = null with get,set
[<AllowNullLiteral>]
type RegistrationBillingPlanInvoiceItemGroupResponse() =
member val name:String = null with get,set
member val description:String = null with get,set
member val rate_code:String = null with get,set
member val rate_description:String = null with get,set
member val total_charges:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val total_credits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val studentSectionInvoiceItems:ResizeArray<StudentSectionInvoiceItemResponse> = new ResizeArray<StudentSectionInvoiceItemResponse>() with get,set
member val invoiceItems:ResizeArray<InvoiceItemResponse> = new ResizeArray<InvoiceItemResponse>() with get,set
member val otherInvoiceItems:ResizeArray<InvoiceItemResponse> = new ResizeArray<InvoiceItemResponse>() with get,set
[<AllowNullLiteral>]
type RegistrationBillingPlanTermResponse() =
member val reporting_term:String = null with get,set
member val term_name:String = null with get,set
member val due_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val total_charges:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val total_credits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val invoiceItemGroups:ResizeArray<RegistrationBillingPlanInvoiceItemGroupResponse> = new ResizeArray<RegistrationBillingPlanInvoiceItemGroupResponse>() with get,set
[<AllowNullLiteral>]
type RegistrationBillingPlanResponse() =
member val transaction_uuid:String = null with get,set
member val uuid:String = null with get,set
member val regent_id:Int32 = new Int32() with get,set
member val reporting_term:String = null with get,set
member val total_charges:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val total_credits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val terms:ResizeArray<RegistrationBillingPlanTermResponse> = new ResizeArray<RegistrationBillingPlanTermResponse>() with get,set
[<AllowNullLiteral>]
type DropRegistrationSubmitRequest() =
member val student_section_uuid:String = null with get,set
member val tuition_refund_amount:Decimal = new Decimal() with get,set
member val description:String = null with get,set
member val additional_rate_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val additional_rate_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val benefit_rate_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val second_benefit_rate_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val benefit_charge_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val second_benefit_charge_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<AllowNullLiteral>]
type DropRegistrationsBillingPlanPreviewRequest() =
member val transaction_uuid:String = null with get,set
member val uuid:String = null with get,set
member val reporting_term:String = null with get,set
member val registrations:ResizeArray<DropRegistrationSubmitRequest> = new ResizeArray<DropRegistrationSubmitRequest>() with get,set
member val description:String = null with get,set
member val drop_fee:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val drop_description:String = null with get,set
member val refund_student_fees:Boolean = new Boolean() with get,set
member val authorizing_uuid:String = null with get,set
F# DropRegistrationsBillingPlanPreviewRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>