regis

<back to all web services

SectionAvailableToChangeForStudentRequest

import Foundation
import ServiceStack

public class SectionAvailableToChangeForStudentRequest : Codable
{
    public var uuid:String
    public var secUUID:String
    public var reporting_term:String

    required public init(){}
}

public class SectionAvailableForStudentResponse : SectionResponse
{
    public var uuid:String
    public var studentSectionUUID:String
    public var registered_amount:Double?
    public var is_full:Bool
    public var is_too_late:Bool
    public var is_too_early:Bool
    public var is_audit:Bool
    public var is_selected:Bool
    public var is_registered:Bool
    public var is_provisional:Bool
    public var is_missing_requisites:Bool
    public var is_completed:Bool
    public var maximum_credit_hours:Double?
    public var maximum_audit_hours:Double?
    public var can_retake:Bool
    public var is_credit_restricted:Bool
    public var is_audit_restricted:Bool
    public var is_oncampus_restricted_for_change:Bool
    public var is_online_restricted_for_change:Bool
    public var can_be_provisional:Bool
    public var can_be_dropped:Bool
    public var ruleMessages:[String] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case uuid
        case studentSectionUUID
        case registered_amount
        case is_full
        case is_too_late
        case is_too_early
        case is_audit
        case is_selected
        case is_registered
        case is_provisional
        case is_missing_requisites
        case is_completed
        case maximum_credit_hours
        case maximum_audit_hours
        case can_retake
        case is_credit_restricted
        case is_audit_restricted
        case is_oncampus_restricted_for_change
        case is_online_restricted_for_change
        case can_be_provisional
        case can_be_dropped
        case ruleMessages
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        uuid = try container.decodeIfPresent(String.self, forKey: .uuid)
        studentSectionUUID = try container.decodeIfPresent(String.self, forKey: .studentSectionUUID)
        registered_amount = try container.decodeIfPresent(Double.self, forKey: .registered_amount)
        is_full = try container.decodeIfPresent(Bool.self, forKey: .is_full)
        is_too_late = try container.decodeIfPresent(Bool.self, forKey: .is_too_late)
        is_too_early = try container.decodeIfPresent(Bool.self, forKey: .is_too_early)
        is_audit = try container.decodeIfPresent(Bool.self, forKey: .is_audit)
        is_selected = try container.decodeIfPresent(Bool.self, forKey: .is_selected)
        is_registered = try container.decodeIfPresent(Bool.self, forKey: .is_registered)
        is_provisional = try container.decodeIfPresent(Bool.self, forKey: .is_provisional)
        is_missing_requisites = try container.decodeIfPresent(Bool.self, forKey: .is_missing_requisites)
        is_completed = try container.decodeIfPresent(Bool.self, forKey: .is_completed)
        maximum_credit_hours = try container.decodeIfPresent(Double.self, forKey: .maximum_credit_hours)
        maximum_audit_hours = try container.decodeIfPresent(Double.self, forKey: .maximum_audit_hours)
        can_retake = try container.decodeIfPresent(Bool.self, forKey: .can_retake)
        is_credit_restricted = try container.decodeIfPresent(Bool.self, forKey: .is_credit_restricted)
        is_audit_restricted = try container.decodeIfPresent(Bool.self, forKey: .is_audit_restricted)
        is_oncampus_restricted_for_change = try container.decodeIfPresent(Bool.self, forKey: .is_oncampus_restricted_for_change)
        is_online_restricted_for_change = try container.decodeIfPresent(Bool.self, forKey: .is_online_restricted_for_change)
        can_be_provisional = try container.decodeIfPresent(Bool.self, forKey: .can_be_provisional)
        can_be_dropped = try container.decodeIfPresent(Bool.self, forKey: .can_be_dropped)
        ruleMessages = try container.decodeIfPresent([String].self, forKey: .ruleMessages) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if uuid != nil { try container.encode(uuid, forKey: .uuid) }
        if studentSectionUUID != nil { try container.encode(studentSectionUUID, forKey: .studentSectionUUID) }
        if registered_amount != nil { try container.encode(registered_amount, forKey: .registered_amount) }
        if is_full != nil { try container.encode(is_full, forKey: .is_full) }
        if is_too_late != nil { try container.encode(is_too_late, forKey: .is_too_late) }
        if is_too_early != nil { try container.encode(is_too_early, forKey: .is_too_early) }
        if is_audit != nil { try container.encode(is_audit, forKey: .is_audit) }
        if is_selected != nil { try container.encode(is_selected, forKey: .is_selected) }
        if is_registered != nil { try container.encode(is_registered, forKey: .is_registered) }
        if is_provisional != nil { try container.encode(is_provisional, forKey: .is_provisional) }
        if is_missing_requisites != nil { try container.encode(is_missing_requisites, forKey: .is_missing_requisites) }
        if is_completed != nil { try container.encode(is_completed, forKey: .is_completed) }
        if maximum_credit_hours != nil { try container.encode(maximum_credit_hours, forKey: .maximum_credit_hours) }
        if maximum_audit_hours != nil { try container.encode(maximum_audit_hours, forKey: .maximum_audit_hours) }
        if can_retake != nil { try container.encode(can_retake, forKey: .can_retake) }
        if is_credit_restricted != nil { try container.encode(is_credit_restricted, forKey: .is_credit_restricted) }
        if is_audit_restricted != nil { try container.encode(is_audit_restricted, forKey: .is_audit_restricted) }
        if is_oncampus_restricted_for_change != nil { try container.encode(is_oncampus_restricted_for_change, forKey: .is_oncampus_restricted_for_change) }
        if is_online_restricted_for_change != nil { try container.encode(is_online_restricted_for_change, forKey: .is_online_restricted_for_change) }
        if can_be_provisional != nil { try container.encode(can_be_provisional, forKey: .can_be_provisional) }
        if can_be_dropped != nil { try container.encode(can_be_dropped, forKey: .can_be_dropped) }
        if ruleMessages.count > 0 { try container.encode(ruleMessages, forKey: .ruleMessages) }
    }
}

public class SectionResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var secUUID:String
    public var course_name:String
    public var section_code:String
    public var course_title:String
    public var course_short_title:String
    public var course_description:String
    public var crosslist_description:String
    public var crosslist_course_name:String
    public var location_long_name:String
    public var room:String
    public var instructors:[InstructorResponse] = []
    public var required_documents:[DocumentResponse] = []
    public var start_date:Date?
    public var end_date:Date?
    public var first_meeting_date:Date?
    public var last_meeting_date:Date?
    public var meeting_days:String
    public var start_times:[String] = []
    public var end_times:[String] = []
    public var is_online_only:Bool
    public var is_weekend:Bool
    public var is_weekday:Bool
    public var is_evening:Bool
    public var is_waitlist:Bool
    public var has_special_requirements:Bool
    public var special_requirements:String
    public var is_unlisted:Bool
    public var credit_amounts:[Double] = []
    public var audit_amounts:[Double] = []
    public var audits_short_name:String
    public var audits_long_name:String
    public var credits_short_name:String
    public var credits_long_name:String
    public var distance_ed_materials:String
    public var prerequisites:String
    public var corequisites:String
    public var capacity:Int?
    public var flat_fee_amount:Double?
    public var additional_fee_amount:Double?
    public var registered_students:Int
    public var three_credit_plus:Int
    public var two_credit:Int
    public var one_credit:Int
    public var three_audit_plus:Int
    public var two_audit:Int
    public var one_audit:Int
    public var crosslist_registered_students:Int
    public var grades_received:Int
    public var crosslist_grades_received:Int
    public var registration_start_date:Date?
    public var registration_end_date:Date?
    public var add_start_date:Date?
    public var add_end_date:Date?
    public var drop_start_date:Date?
    public var drop_end_date:Date?
    public var grading_end_date:Date?
    public var term:String
    public var reporting_term:String
    public var reporting_year:Int
    public var current_status:String
    public var added_by:String
    public var added_date:Date?
    public var changed_by:String
    public var changed_date:Date?
    public var timestamp:Date

    required public init(){}
}

public class InstructorResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var regent_login:String
    public var preferred_name:String
    public var first_name:String
    public var last_name:String
    public var full_name:String
    public var email:String
    public var image_base64:String

    required public init(){}
}

public class DocumentResponse : Codable
{
    public var code:String
    public var document_name:String
    public var document_description:String

    required public init(){}
}

Swift SectionAvailableToChangeForStudentRequest DTOs

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

<SectionAvailableToChangeForStudentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <reporting_term>String</reporting_term>
  <secUUID>String</secUUID>
  <uuid>String</uuid>
</SectionAvailableToChangeForStudentRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SectionAvailableForStudentResponse 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>
  <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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1: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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1: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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1: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: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>
      <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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1: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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ruleMessages>
  <studentSectionUUID>String</studentSectionUUID>
  <uuid>String</uuid>
</SectionAvailableForStudentResponse>