| Required role: | REGISUserRole |
| 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 .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
}
]
}
]
}
]
}