regis

<back to all web services

SectionsAvailableForStudentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/Available/{uuid}/Term/{reporting_term}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class SectionsAvailableForStudentRequest
{
    var uuid:String? = null
    var transaction_uuid:String? = null
    var reporting_term:String? = null
    var online_only:Boolean? = null
    var oncampus_only:Boolean? = null
    var is_admin:Boolean? = null
}

open class SectionsAvailableForStudentResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var uuid:String? = null
    var reporting_term:String? = null
    var notifyOfAcademicProbation:Boolean? = null
    var sectionsAvailable:ArrayList<SectionAvailableForStudentResponse> = ArrayList<SectionAvailableForStudentResponse>()
    var messages:ArrayList<String> = ArrayList<String>()
}

open class SectionAvailableForStudentResponse : SectionResponse()
{
    var uuid:String? = null
    var studentSectionUUID:String? = null
    var registered_amount:BigDecimal? = null
    var is_full:Boolean? = null
    var is_too_late:Boolean? = null
    var is_too_early:Boolean? = null
    var is_audit:Boolean? = null
    var is_selected:Boolean? = null
    var is_registered:Boolean? = null
    var is_provisional:Boolean? = null
    var is_missing_requisites:Boolean? = null
    var is_completed:Boolean? = null
    var maximum_credit_hours:BigDecimal? = null
    var maximum_audit_hours:BigDecimal? = null
    var can_retake:Boolean? = null
    var is_credit_restricted:Boolean? = null
    var is_audit_restricted:Boolean? = null
    var is_oncampus_restricted_for_change:Boolean? = null
    var is_online_restricted_for_change:Boolean? = null
    var can_be_provisional:Boolean? = null
    var can_be_dropped:Boolean? = null
    var ruleMessages:ArrayList<String> = ArrayList<String>()
}

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
}

Kotlin SectionsAvailableForStudentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Sections/Available/{uuid}/Term/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SectionsAvailableForStudentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <is_admin>false</is_admin>
  <oncampus_only>false</oncampus_only>
  <online_only>false</online_only>
  <reporting_term>String</reporting_term>
  <transaction_uuid>String</transaction_uuid>
  <uuid>String</uuid>
</SectionsAvailableForStudentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SectionsAvailableForStudentResponse 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>
  <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </messages>
  <notifyOfAcademicProbation>false</notifyOfAcademicProbation>
  <regent_id>0</regent_id>
  <reporting_term>String</reporting_term>
  <sectionsAvailable>
    <SectionAvailableForStudentResponse>
      <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>
      <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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>0</d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>0</d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1: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: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 xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:KeyValueOfstringstring>
                    <d9p1:Key>String</d9p1:Key>
                    <d9p1:Value>String</d9p1:Value>
                  </d9p1:KeyValueOfstringstring>
                </d6p1:Meta>
              </d6p1:ResponseError>
            </d6p1:Errors>
            <d6p1: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>
            </d6p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1: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>
      <can_be_dropped>false</can_be_dropped>
      <can_be_provisional>false</can_be_provisional>
      <can_retake>false</can_retake>
      <is_audit>false</is_audit>
      <is_audit_restricted>false</is_audit_restricted>
      <is_completed>false</is_completed>
      <is_credit_restricted>false</is_credit_restricted>
      <is_full>false</is_full>
      <is_missing_requisites>false</is_missing_requisites>
      <is_oncampus_restricted_for_change>false</is_oncampus_restricted_for_change>
      <is_online_restricted_for_change>false</is_online_restricted_for_change>
      <is_provisional>false</is_provisional>
      <is_registered>false</is_registered>
      <is_selected>false</is_selected>
      <is_too_early>false</is_too_early>
      <is_too_late>false</is_too_late>
      <maximum_audit_hours>0</maximum_audit_hours>
      <maximum_credit_hours>0</maximum_credit_hours>
      <registered_amount>0</registered_amount>
      <ruleMessages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </ruleMessages>
      <studentSectionUUID>String</studentSectionUUID>
      <uuid>String</uuid>
    </SectionAvailableForStudentResponse>
  </sectionsAvailable>
  <uuid>String</uuid>
</SectionsAvailableForStudentResponse>