Required role: | REGISUserRole |
POST | /Registration/Provisional/{student_section_uuid}/Authorize |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class ProvisionalRegistrationAuthorizeRequest
{
var student_section_uuid:String? = null
var authorizing_uuid:String? = null
}
open class AddRegistrationsResponse : InvoiceResponse()
{
var transaction_uuid:String? = null
var studentSectionInvoiceItems:ArrayList<StudentSectionInvoiceItemResponse> = ArrayList<StudentSectionInvoiceItemResponse>()
var sectionRates:HashMap<String,ArrayList<SectionRateWithAmountResponse>> = HashMap<String,ArrayList<SectionRateWithAmountResponse>>()
var creditTuitionRate:InvoiceItemAdminResponse? = null
var auditTuitionRate:InvoiceItemAdminResponse? = null
var studentAge:Int? = null
var studentAgeAtEarliestSectionStartDate:Int? = null
var isRegentGrad:Boolean? = null
var isOnlyUnclassified:Boolean? = null
var canRegisterForAuditInTerm:Boolean? = null
var canRegisterForCreditInTerm:Boolean? = null
var messages:ArrayList<String> = ArrayList<String>()
var currentTermAuditHours:BigDecimal? = null
var currentTermCreditHours:BigDecimal? = null
var totalCreditHours:BigDecimal? = null
var availableInvoiceItems:ArrayList<InvoiceItemAdminResponse> = ArrayList<InvoiceItemAdminResponse>()
var availableBenefits:ArrayList<BenefitResponse> = ArrayList<BenefitResponse>()
}
open class InvoiceResponse
{
var responseStatus:ResponseStatus? = null
var invoiceUUID:String? = null
var regent_id:Int? = null
var uuid:String? = null
var reporting_term:String? = null
var total_charges:BigDecimal? = null
var total_credits:BigDecimal? = null
var current_status:String? = null
var timestamp:Date? = null
}
open class StudentSectionInvoiceItemResponse : InvoiceItemResponse()
{
var studentSection:StudentSectionResponse? = null
}
open class InvoiceItemResponse
{
var responseStatus:ResponseStatus? = null
var invoiceItemUUID:String? = null
var rate_id:Int? = null
var rate_code:String? = null
var rate_description:String? = null
var charge:BigDecimal? = null
var credit:BigDecimal? = null
}
open class StudentSectionResponse : SectionResponse()
{
var studentSectionUUID:String? = null
var registered_amount:BigDecimal? = null
var is_provisional:Boolean? = null
var is_audit:Boolean? = null
}
open class SectionResponse
{
var responseStatus:ResponseStatus? = null
var secUUID:String? = null
var course_name:String? = null
var section_code:String? = null
var course_title:String? = null
var course_short_title:String? = null
var course_description:String? = null
var crosslist_description:String? = null
var crosslist_course_name:String? = null
var location_long_name:String? = null
var room:String? = null
var instructors:ArrayList<InstructorResponse> = ArrayList<InstructorResponse>()
var required_documents:ArrayList<DocumentResponse> = ArrayList<DocumentResponse>()
var start_date:Date? = null
var end_date:Date? = null
var first_meeting_date:Date? = null
var last_meeting_date:Date? = null
var meeting_days:String? = null
var start_times:ArrayList<String> = ArrayList<String>()
var end_times:ArrayList<String> = ArrayList<String>()
var is_online_only:Boolean? = null
var is_weekend:Boolean? = null
var is_weekday:Boolean? = null
var is_evening:Boolean? = null
var is_waitlist:Boolean? = null
var has_special_requirements:Boolean? = null
var special_requirements:String? = null
var is_unlisted:Boolean? = null
var credit_amounts:ArrayList<BigDecimal> = ArrayList<BigDecimal>()
var audit_amounts:ArrayList<BigDecimal> = ArrayList<BigDecimal>()
var audits_short_name:String? = null
var audits_long_name:String? = null
var credits_short_name:String? = null
var credits_long_name:String? = null
var distance_ed_materials:String? = null
var prerequisites:String? = null
var corequisites:String? = null
var capacity:Int? = null
var flat_fee_amount:BigDecimal? = null
var additional_fee_amount:BigDecimal? = null
var registered_students:Int? = null
var three_credit_plus:Int? = null
var two_credit:Int? = null
var one_credit:Int? = null
var three_audit_plus:Int? = null
var two_audit:Int? = null
var one_audit:Int? = null
var crosslist_registered_students:Int? = null
var grades_received:Int? = null
var crosslist_grades_received:Int? = null
var registration_start_date:Date? = null
var registration_end_date:Date? = null
var add_start_date:Date? = null
var add_end_date:Date? = null
var drop_start_date:Date? = null
var drop_end_date:Date? = null
var grading_end_date:Date? = null
var term:String? = null
var reporting_term:String? = null
var reporting_year:Int? = null
var current_status:String? = null
var added_by:String? = null
var added_date:Date? = null
var changed_by:String? = null
var changed_date:Date? = null
var timestamp:Date? = null
}
open class InstructorResponse
{
var responseStatus:ResponseStatus? = null
var regent_id:Int? = null
var regent_login:String? = null
var preferred_name:String? = null
var first_name:String? = null
var last_name:String? = null
var full_name:String? = null
var email:String? = null
var image_base64:String? = null
}
open class DocumentResponse
{
var code:String? = null
var document_name:String? = null
var document_description:String? = null
}
open class InvoiceItemAdminResponse
{
var responseStatus:ResponseStatus? = null
var invoiceItemUUID:String? = null
var rate_id:Int? = null
var rate_code:String? = null
var rate_description:String? = null
var is_required:Boolean? = null
var is_optional:Boolean? = null
var charge:BigDecimal? = null
var credit:BigDecimal? = null
}
open class BenefitResponse
{
var rate_id:Int? = null
var rate_code:String? = null
var rate_description:String? = null
var percentage_rate:BigDecimal? = null
var is_optional:Boolean? = null
var is_required:Boolean? = null
}
Kotlin ProvisionalRegistrationAuthorizeRequest 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/Provisional/{student_section_uuid}/Authorize HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ProvisionalRegistrationAuthorizeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<authorizing_uuid>String</authorizing_uuid>
<student_section_uuid>String</student_section_uuid>
</ProvisionalRegistrationAuthorizeRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AddRegistrationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <current_status>String</current_status> <invoiceUUID>String</invoiceUUID> <regent_id>0</regent_id> <reporting_term>String</reporting_term> <timestamp>0001-01-01T00:00:00</timestamp> <total_charges>0</total_charges> <total_credits>0</total_credits> <uuid>String</uuid> <auditTuitionRate> <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types"> <d3p1:ErrorCode>String</d3p1:ErrorCode> <d3p1:Message>String</d3p1:Message> <d3p1:StackTrace>String</d3p1:StackTrace> <d3p1:Errors> <d3p1:ResponseError> <d3p1:ErrorCode>String</d3p1:ErrorCode> <d3p1:FieldName>String</d3p1:FieldName> <d3p1:Message>String</d3p1:Message> <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:KeyValueOfstringstring> <d6p1:Key>String</d6p1:Key> <d6p1:Value>String</d6p1:Value> </d6p1:KeyValueOfstringstring> </d3p1:Meta> </d3p1:ResponseError> </d3p1:Errors> <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringstring> <d4p1:Key>String</d4p1:Key> <d4p1:Value>String</d4p1:Value> </d4p1:KeyValueOfstringstring> </d3p1:Meta> </ResponseStatus> <charge>0</charge> <credit>0</credit> <invoiceItemUUID>String</invoiceItemUUID> <is_optional>false</is_optional> <is_required>false</is_required> <rate_code>String</rate_code> <rate_description>String</rate_description> <rate_id>0</rate_id> </auditTuitionRate> <availableBenefits> <BenefitResponse> <is_optional>false</is_optional> <is_required>false</is_required> <percentage_rate>0</percentage_rate> <rate_code>String</rate_code> <rate_description>String</rate_description> <rate_id>0</rate_id> </BenefitResponse> </availableBenefits> <availableInvoiceItems> <InvoiceItemAdminResponse> <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types"> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:Message>String</d4p1:Message> <d4p1:StackTrace>String</d4p1:StackTrace> <d4p1:Errors> <d4p1:ResponseError> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:FieldName>String</d4p1:FieldName> <d4p1:Message>String</d4p1:Message> <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:KeyValueOfstringstring> <d7p1:Key>String</d7p1:Key> <d7p1:Value>String</d7p1:Value> </d7p1:KeyValueOfstringstring> </d4p1:Meta> </d4p1:ResponseError> </d4p1:Errors> <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d4p1:Meta> </ResponseStatus> <charge>0</charge> <credit>0</credit> <invoiceItemUUID>String</invoiceItemUUID> <is_optional>false</is_optional> <is_required>false</is_required> <rate_code>String</rate_code> <rate_description>String</rate_description> <rate_id>0</rate_id> </InvoiceItemAdminResponse> </availableInvoiceItems> <canRegisterForAuditInTerm>false</canRegisterForAuditInTerm> <canRegisterForCreditInTerm>false</canRegisterForCreditInTerm> <creditTuitionRate> <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types"> <d3p1:ErrorCode>String</d3p1:ErrorCode> <d3p1:Message>String</d3p1:Message> <d3p1:StackTrace>String</d3p1:StackTrace> <d3p1:Errors> <d3p1:ResponseError> <d3p1:ErrorCode>String</d3p1:ErrorCode> <d3p1:FieldName>String</d3p1:FieldName> <d3p1:Message>String</d3p1:Message> <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:KeyValueOfstringstring> <d6p1:Key>String</d6p1:Key> <d6p1:Value>String</d6p1:Value> </d6p1:KeyValueOfstringstring> </d3p1:Meta> </d3p1:ResponseError> </d3p1:Errors> <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringstring> <d4p1:Key>String</d4p1:Key> <d4p1:Value>String</d4p1:Value> </d4p1:KeyValueOfstringstring> </d3p1:Meta> </ResponseStatus> <charge>0</charge> <credit>0</credit> <invoiceItemUUID>String</invoiceItemUUID> <is_optional>false</is_optional> <is_required>false</is_required> <rate_code>String</rate_code> <rate_description>String</rate_description> <rate_id>0</rate_id> </creditTuitionRate> <currentTermAuditHours>0</currentTermAuditHours> <currentTermCreditHours>0</currentTermCreditHours> <isOnlyUnclassified>false</isOnlyUnclassified> <isRegentGrad>false</isRegentGrad> <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>String</d2p1:string> </messages> <sectionRates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringArrayOfSectionRateWithAmountResponsezpaGewPN> <d2p1:Key>String</d2p1:Key> <d2p1:Value> <SectionRateWithAmountResponse> <ResponseStatus xmlns:d6p1="http://schemas.servicestack.net/types"> <d6p1:ErrorCode>String</d6p1:ErrorCode> <d6p1:Message>String</d6p1:Message> <d6p1:StackTrace>String</d6p1:StackTrace> <d6p1:Errors> <d6p1:ResponseError> <d6p1:ErrorCode>String</d6p1:ErrorCode> <d6p1:FieldName>String</d6p1:FieldName> <d6p1:Message>String</d6p1:Message> <d6p1:Meta> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </d6p1:Meta> </d6p1:ResponseError> </d6p1:Errors> <d6p1:Meta> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </d6p1:Meta> </ResponseStatus> <course_name>String</course_name> <is_override_audit_rate>false</is_override_audit_rate> <is_override_credit_rate>false</is_override_credit_rate> <rate_code>String</rate_code> <rate_description>String</rate_description> <reporting_term>String</reporting_term> <secUUID>String</secUUID> <section_code>String</section_code> <section_id>0</section_id> <title>String</title> <uuid>String</uuid> <charge>0</charge> <credit>0</credit> <rate_id>0</rate_id> </SectionRateWithAmountResponse> </d2p1:Value> </d2p1:KeyValueOfstringArrayOfSectionRateWithAmountResponsezpaGewPN> </sectionRates> <studentAge>0</studentAge> <studentAgeAtEarliestSectionStartDate>0</studentAgeAtEarliestSectionStartDate> <studentSectionInvoiceItems> <StudentSectionInvoiceItemResponse> <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types"> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:Message>String</d4p1:Message> <d4p1:StackTrace>String</d4p1:StackTrace> <d4p1:Errors> <d4p1:ResponseError> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:FieldName>String</d4p1:FieldName> <d4p1:Message>String</d4p1:Message> <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:KeyValueOfstringstring> <d7p1:Key>String</d7p1:Key> <d7p1:Value>String</d7p1:Value> </d7p1:KeyValueOfstringstring> </d4p1:Meta> </d4p1:ResponseError> </d4p1:Errors> <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d4p1: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> <studentSection> <ResponseStatus xmlns:d5p1="http://schemas.servicestack.net/types"> <d5p1:ErrorCode>String</d5p1:ErrorCode> <d5p1:Message>String</d5p1:Message> <d5p1:StackTrace>String</d5p1:StackTrace> <d5p1:Errors> <d5p1:ResponseError> <d5p1:ErrorCode>String</d5p1:ErrorCode> <d5p1:FieldName>String</d5p1:FieldName> <d5p1:Message>String</d5p1:Message> <d5p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>String</d8p1:Key> <d8p1:Value>String</d8p1:Value> </d8p1:KeyValueOfstringstring> </d5p1:Meta> </d5p1:ResponseError> </d5p1:Errors> <d5p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:KeyValueOfstringstring> <d6p1:Key>String</d6p1:Key> <d6p1:Value>String</d6p1:Value> </d6p1:KeyValueOfstringstring> </d5p1: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:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:decimal>0</d5p1: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:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:decimal>0</d5p1: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:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1: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:d7p1="http://schemas.servicestack.net/types"> <d7p1:ErrorCode>String</d7p1:ErrorCode> <d7p1:Message>String</d7p1:Message> <d7p1:StackTrace>String</d7p1:StackTrace> <d7p1:Errors> <d7p1:ResponseError> <d7p1:ErrorCode>String</d7p1:ErrorCode> <d7p1:FieldName>String</d7p1:FieldName> <d7p1:Message>String</d7p1:Message> <d7p1: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> </d7p1:Meta> </d7p1:ResponseError> </d7p1:Errors> <d7p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>String</d8p1:Key> <d8p1:Value>String</d8p1:Value> </d8p1:KeyValueOfstringstring> </d7p1: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:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1: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> <totalCreditHours>0</totalCreditHours> <transaction_uuid>String</transaction_uuid> </AddRegistrationsResponse>