| Required role: | REGISUserRole |
| POST | /Registration/{uuid}/Drop/{reporting_term}/BillingPlanPreview |
|---|
export class InvoiceItemResponse
{
public responseStatus: ResponseStatus;
public invoiceItemUUID: string;
public rate_id: number;
public rate_code: string;
public rate_description: string;
public reporting_term: string;
public charge?: number;
public credit?: number;
public constructor(init?: Partial<InvoiceItemResponse>) { (Object as any).assign(this, init); }
}
export class InstructorResponse
{
public responseStatus: ResponseStatus;
public regent_id: number;
public regent_login: string;
public preferred_name: string;
public first_name: string;
public last_name: string;
public full_name: string;
public email: string;
public image_base64: string;
public constructor(init?: Partial<InstructorResponse>) { (Object as any).assign(this, init); }
}
export class DocumentResponse
{
public code: string;
public document_name: string;
public document_description: string;
public constructor(init?: Partial<DocumentResponse>) { (Object as any).assign(this, init); }
}
export class SectionResponse
{
public responseStatus: ResponseStatus;
public secUUID: string;
public course_name: string;
public section_code: string;
public course_title: string;
public course_short_title: string;
public course_description: string;
public crosslist_description: string;
public crosslist_course_name: string;
public location_long_name: string;
public room: string;
public instructors: InstructorResponse[];
public required_documents: DocumentResponse[];
public start_date?: string;
public end_date?: string;
public first_meeting_date?: string;
public last_meeting_date?: string;
public meeting_days: string;
public start_times: string[];
public end_times: string[];
public is_online_only: boolean;
public is_weekend: boolean;
public is_weekday: boolean;
public is_evening: boolean;
public is_waitlist: boolean;
public has_special_requirements: boolean;
public special_requirements: string;
public is_unlisted: boolean;
public credit_amounts: number[];
public audit_amounts: number[];
public audits_short_name: string;
public audits_long_name: string;
public credits_short_name: string;
public credits_long_name: string;
public distance_ed_materials: string;
public prerequisites: string;
public corequisites: string;
public capacity?: number;
public flat_fee_amount?: number;
public additional_fee_amount?: number;
public registered_students: number;
public three_credit_plus: number;
public two_credit: number;
public one_credit: number;
public three_audit_plus: number;
public two_audit: number;
public one_audit: number;
public crosslist_registered_students: number;
public grades_received: number;
public crosslist_grades_received: number;
public registration_start_date?: string;
public registration_end_date?: string;
public add_start_date?: string;
public add_end_date?: string;
public drop_start_date?: string;
public drop_end_date?: string;
public grading_end_date?: string;
public term: string;
public reporting_term: string;
public reporting_year: number;
public current_status: string;
public added_by: string;
public added_date?: string;
public changed_by: string;
public changed_date?: string;
public timestamp: string;
public constructor(init?: Partial<SectionResponse>) { (Object as any).assign(this, init); }
}
export class StudentSectionResponse extends SectionResponse
{
public studentSectionUUID: string;
public registered_amount: number;
public is_provisional: boolean;
public is_audit: boolean;
public constructor(init?: Partial<StudentSectionResponse>) { super(init); (Object as any).assign(this, init); }
}
export class StudentSectionInvoiceItemResponse extends InvoiceItemResponse
{
public studentSection: StudentSectionResponse;
public constructor(init?: Partial<StudentSectionInvoiceItemResponse>) { super(init); (Object as any).assign(this, init); }
}
export class RegistrationBillingPlanInvoiceItemGroupResponse
{
public name: string;
public description: string;
public rate_code: string;
public rate_description: string;
public total_charges?: number;
public total_credits?: number;
public studentSectionInvoiceItems: StudentSectionInvoiceItemResponse[];
public invoiceItems: InvoiceItemResponse[];
public otherInvoiceItems: InvoiceItemResponse[];
public constructor(init?: Partial<RegistrationBillingPlanInvoiceItemGroupResponse>) { (Object as any).assign(this, init); }
}
export class RegistrationBillingPlanTermResponse
{
public reporting_term: string;
public term_name: string;
public due_date?: string;
public total_charges?: number;
public total_credits?: number;
public invoiceItemGroups: RegistrationBillingPlanInvoiceItemGroupResponse[];
public constructor(init?: Partial<RegistrationBillingPlanTermResponse>) { (Object as any).assign(this, init); }
}
export class RegistrationBillingPlanResponse
{
public transaction_uuid: string;
public uuid: string;
public regent_id: number;
public reporting_term: string;
public total_charges?: number;
public total_credits?: number;
public terms: RegistrationBillingPlanTermResponse[];
public constructor(init?: Partial<RegistrationBillingPlanResponse>) { (Object as any).assign(this, init); }
}
export class DropRegistrationSubmitRequest
{
public student_section_uuid: string;
public tuition_refund_amount: number;
public description: string;
public additional_rate_id?: number;
public additional_rate_amount?: number;
public benefit_rate_id?: number;
public second_benefit_rate_id?: number;
public benefit_charge_amount?: number;
public second_benefit_charge_amount?: number;
public constructor(init?: Partial<DropRegistrationSubmitRequest>) { (Object as any).assign(this, init); }
}
export class DropRegistrationsBillingPlanPreviewRequest
{
public transaction_uuid: string;
public uuid: string;
public reporting_term: string;
public registrations: DropRegistrationSubmitRequest[];
public description: string;
public drop_fee?: number;
public drop_description: string;
public refund_student_fees: boolean;
public authorizing_uuid: string;
public constructor(init?: Partial<DropRegistrationsBillingPlanPreviewRequest>) { (Object as any).assign(this, init); }
}
TypeScript DropRegistrationsBillingPlanPreviewRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
transaction_uuid: String,
uuid: String,
reporting_term: String,
registrations:
[
{
student_section_uuid: String,
tuition_refund_amount: 0,
description: String,
additional_rate_id: 0,
additional_rate_amount: 0,
benefit_rate_id: 0,
second_benefit_rate_id: 0,
benefit_charge_amount: 0,
second_benefit_charge_amount: 0
}
],
description: String,
drop_fee: 0,
drop_description: String,
refund_student_fees: False,
authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
transaction_uuid: String,
uuid: String,
regent_id: 0,
reporting_term: String,
total_charges: 0,
total_credits: 0,
terms:
[
{
reporting_term: String,
term_name: String,
due_date: 0001-01-01,
total_charges: 0,
total_credits: 0,
invoiceItemGroups:
[
{
name: String,
description: String,
rate_code: String,
rate_description: String,
total_charges: 0,
total_credits: 0,
studentSectionInvoiceItems:
[
{
studentSection:
{
studentSectionUUID: String,
registered_amount: 0,
is_provisional: False,
is_audit: False,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
secUUID: String,
course_name: String,
section_code: String,
course_title: String,
course_short_title: String,
course_description: String,
crosslist_description: String,
crosslist_course_name: String,
location_long_name: String,
room: String,
instructors:
[
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
regent_id: 0,
regent_login: String,
preferred_name: String,
first_name: String,
last_name: String,
full_name: String,
email: String,
image_base64: String
}
],
required_documents:
[
{
code: String,
document_name: String,
document_description: String
}
],
start_date: 0001-01-01,
end_date: 0001-01-01,
first_meeting_date: 0001-01-01,
last_meeting_date: 0001-01-01,
meeting_days: String,
start_times:
[
String
],
end_times:
[
String
],
is_online_only: False,
is_weekend: False,
is_weekday: False,
is_evening: False,
is_waitlist: False,
has_special_requirements: False,
special_requirements: String,
is_unlisted: False,
credit_amounts:
[
0
],
audit_amounts:
[
0
],
audits_short_name: String,
audits_long_name: String,
credits_short_name: String,
credits_long_name: String,
distance_ed_materials: String,
prerequisites: String,
corequisites: String,
capacity: 0,
flat_fee_amount: 0,
additional_fee_amount: 0,
registered_students: 0,
three_credit_plus: 0,
two_credit: 0,
one_credit: 0,
three_audit_plus: 0,
two_audit: 0,
one_audit: 0,
crosslist_registered_students: 0,
grades_received: 0,
crosslist_grades_received: 0,
registration_start_date: 0001-01-01,
registration_end_date: 0001-01-01,
add_start_date: 0001-01-01,
add_end_date: 0001-01-01,
drop_start_date: 0001-01-01,
drop_end_date: 0001-01-01,
grading_end_date: 0001-01-01,
term: String,
reporting_term: String,
reporting_year: 0,
current_status: String,
added_by: String,
added_date: 0001-01-01,
changed_by: String,
changed_date: 0001-01-01,
timestamp: 0001-01-01
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
invoiceItemUUID: String,
rate_id: 0,
rate_code: String,
rate_description: String,
reporting_term: String,
charge: 0,
credit: 0
}
],
invoiceItems:
[
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
invoiceItemUUID: String,
rate_id: 0,
rate_code: String,
rate_description: String,
reporting_term: String,
charge: 0,
credit: 0
}
],
otherInvoiceItems:
[
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
invoiceItemUUID: String,
rate_id: 0,
rate_code: String,
rate_description: String,
reporting_term: String,
charge: 0,
credit: 0
}
]
}
]
}
]
}