| Required role: | REGISUserRole |
| POST | /Registration/{uuid}/Drop/{reporting_term}/BillingPlanPreview |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceItemResponse:
response_status: Optional[ResponseStatus] = None
invoice_item_u_u_i_d: Optional[str] = None
rate_id: int = 0
rate_code: Optional[str] = None
rate_description: Optional[str] = None
reporting_term: Optional[str] = None
charge: Optional[Decimal] = None
credit: Optional[Decimal] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InstructorResponse:
response_status: Optional[ResponseStatus] = None
regent_id: int = 0
regent_login: Optional[str] = None
preferred_name: Optional[str] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
full_name: Optional[str] = None
email: Optional[str] = None
image_base64: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentResponse:
code: Optional[str] = None
document_name: Optional[str] = None
document_description: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SectionResponse:
response_status: Optional[ResponseStatus] = None
sec_u_u_i_d: Optional[str] = None
course_name: Optional[str] = None
section_code: Optional[str] = None
course_title: Optional[str] = None
course_short_title: Optional[str] = None
course_description: Optional[str] = None
crosslist_description: Optional[str] = None
crosslist_course_name: Optional[str] = None
location_long_name: Optional[str] = None
room: Optional[str] = None
instructors: Optional[List[InstructorResponse]] = None
required_documents: Optional[List[DocumentResponse]] = None
start_date: Optional[datetime.datetime] = None
end_date: Optional[datetime.datetime] = None
first_meeting_date: Optional[datetime.datetime] = None
last_meeting_date: Optional[datetime.datetime] = None
meeting_days: Optional[str] = None
start_times: Optional[List[str]] = None
end_times: Optional[List[str]] = None
is_online_only: bool = False
is_weekend: bool = False
is_weekday: bool = False
is_evening: bool = False
is_waitlist: bool = False
has_special_requirements: bool = False
special_requirements: Optional[str] = None
is_unlisted: bool = False
credit_amounts: Optional[List[Decimal]] = None
audit_amounts: Optional[List[Decimal]] = None
audits_short_name: Optional[str] = None
audits_long_name: Optional[str] = None
credits_short_name: Optional[str] = None
credits_long_name: Optional[str] = None
distance_ed_materials: Optional[str] = None
prerequisites: Optional[str] = None
corequisites: Optional[str] = None
capacity: Optional[int] = None
flat_fee_amount: Optional[Decimal] = None
additional_fee_amount: Optional[Decimal] = None
registered_students: int = 0
three_credit_plus: int = 0
two_credit: int = 0
one_credit: int = 0
three_audit_plus: int = 0
two_audit: int = 0
one_audit: int = 0
crosslist_registered_students: int = 0
grades_received: int = 0
crosslist_grades_received: int = 0
registration_start_date: Optional[datetime.datetime] = None
registration_end_date: Optional[datetime.datetime] = None
add_start_date: Optional[datetime.datetime] = None
add_end_date: Optional[datetime.datetime] = None
drop_start_date: Optional[datetime.datetime] = None
drop_end_date: Optional[datetime.datetime] = None
grading_end_date: Optional[datetime.datetime] = None
term: Optional[str] = None
reporting_term: Optional[str] = None
reporting_year: int = 0
current_status: Optional[str] = None
added_by: Optional[str] = None
added_date: Optional[datetime.datetime] = None
changed_by: Optional[str] = None
changed_date: Optional[datetime.datetime] = None
timestamp: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentSectionResponse(SectionResponse):
student_section_u_u_i_d: Optional[str] = None
registered_amount: Decimal = decimal.Decimal(0)
is_provisional: bool = False
is_audit: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentSectionInvoiceItemResponse(InvoiceItemResponse):
student_section: Optional[StudentSectionResponse] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegistrationBillingPlanInvoiceItemGroupResponse:
name: Optional[str] = None
description: Optional[str] = None
rate_code: Optional[str] = None
rate_description: Optional[str] = None
total_charges: Optional[Decimal] = None
total_credits: Optional[Decimal] = None
student_section_invoice_items: Optional[List[StudentSectionInvoiceItemResponse]] = None
invoice_items: Optional[List[InvoiceItemResponse]] = None
other_invoice_items: Optional[List[InvoiceItemResponse]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegistrationBillingPlanTermResponse:
reporting_term: Optional[str] = None
term_name: Optional[str] = None
due_date: Optional[datetime.datetime] = None
total_charges: Optional[Decimal] = None
total_credits: Optional[Decimal] = None
invoice_item_groups: Optional[List[RegistrationBillingPlanInvoiceItemGroupResponse]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegistrationBillingPlanResponse:
transaction_uuid: Optional[str] = None
uuid: Optional[str] = None
regent_id: int = 0
reporting_term: Optional[str] = None
total_charges: Optional[Decimal] = None
total_credits: Optional[Decimal] = None
terms: Optional[List[RegistrationBillingPlanTermResponse]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DropRegistrationSubmitRequest:
student_section_uuid: Optional[str] = None
tuition_refund_amount: Decimal = decimal.Decimal(0)
description: Optional[str] = None
additional_rate_id: Optional[int] = None
additional_rate_amount: Optional[Decimal] = None
benefit_rate_id: Optional[int] = None
second_benefit_rate_id: Optional[int] = None
benefit_charge_amount: Optional[Decimal] = None
second_benefit_charge_amount: Optional[Decimal] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DropRegistrationsBillingPlanPreviewRequest:
transaction_uuid: Optional[str] = None
uuid: Optional[str] = None
reporting_term: Optional[str] = None
registrations: Optional[List[DropRegistrationSubmitRequest]] = None
description: Optional[str] = None
drop_fee: Optional[Decimal] = None
drop_description: Optional[str] = None
refund_student_fees: bool = False
authorizing_uuid: Optional[str] = None
Python 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>