regis

SectionsAdminRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Sections/Admin/{reporting_term}

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class SectionsAdminRequest
            Public Overridable Property reporting_term As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class SectionAdminResponse
            Public Overridable Property uuid As String
            Public Overridable Property section_id As Integer
            Public Overridable Property course_id As Nullable(Of Integer)
            Public Overridable Property course_name As String
            Public Overridable Property min_credits As Nullable(Of Decimal)
            Public Overridable Property max_credits As Nullable(Of Decimal)
            Public Overridable Property credit_increments As Nullable(Of Decimal)
            Public Overridable Property min_audits As Nullable(Of Decimal)
            Public Overridable Property max_audits As Nullable(Of Decimal)
            Public Overridable Property audit_increments As Nullable(Of Decimal)
            Public Overridable Property section_code As String
            Public Overridable Property title As String
            Public Overridable Property pretty_title As String
            Public Overridable Property override_course_description As String
            Public Overridable Property current_status As String
            Public Overridable Property location As String
            Public Overridable Property room As String
            Public Overridable Property is_audio As Boolean
            Public Overridable Property is_oncampus As Boolean
            Public Overridable Property distance_ed_materials As String
            Public Overridable Property start_date As Nullable(Of Date)
            Public Overridable Property end_date As Nullable(Of Date)
            Public Overridable Property first_meeting_date As Nullable(Of Date)
            Public Overridable Property last_meeting_date As Nullable(Of Date)
            Public Overridable Property meeting_days As String
            Public Overridable Property start_times As String
            Public Overridable Property end_times As String
            Public Overridable Property is_pass_fail As Boolean
            Public Overridable Property is_weekend As Boolean
            Public Overridable Property is_weekday As Boolean
            Public Overridable Property is_evening As Boolean
            Public Overridable Property is_waitlist As Boolean
            Public Overridable Property has_special_requirements As Boolean
            Public Overridable Property special_requirements As String
            Public Overridable Property is_unlisted As Boolean
            Public Overridable Property capacity As Nullable(Of Integer)
            Public Overridable Property flat_fee_amount As Nullable(Of Decimal)
            Public Overridable Property additional_fee_amount As Nullable(Of Decimal)
            Public Overridable Property override_registration_start_date As Nullable(Of Date)
            Public Overridable Property override_registration_end_date As Nullable(Of Date)
            Public Overridable Property override_add_start_date As Nullable(Of Date)
            Public Overridable Property override_add_end_date As Nullable(Of Date)
            Public Overridable Property override_drop_start_date As Nullable(Of Date)
            Public Overridable Property override_drop_end_date As Nullable(Of Date)
            Public Overridable Property override_grading_end_date As Nullable(Of Date)
            Public Overridable Property term As String
            Public Overridable Property reporting_term As String
            Public Overridable Property reporting_year As Integer
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property added_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property timestamp As Date
        End Class

        Public Partial Class SectionsAdminResponse
            Public Sub New()
                sections = New List(Of SectionAdminResponse)
                section_rates = New Dictionary(Of Integer, List(Of SectionRateWithAmountResponse))
                section_refund_schedules = New Dictionary(Of Integer, List(Of SectionRefundScheduleResponse))
                locations = New List(Of String)
                section_instructors = New Dictionary(Of Integer, List(Of InstructorResponse))
                section_document_codes = New Dictionary(Of Integer, List(Of String))
                crosslisted_sections = New Dictionary(Of Integer, List(Of Int32))
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property reporting_term As String
            Public Overridable Property sections As List(Of SectionAdminResponse)
            Public Overridable Property section_rates As Dictionary(Of Integer, List(Of SectionRateWithAmountResponse))
            Public Overridable Property section_refund_schedules As Dictionary(Of Integer, List(Of SectionRefundScheduleResponse))
            Public Overridable Property locations As List(Of String)
            Public Overridable Property section_instructors As Dictionary(Of Integer, List(Of InstructorResponse))
            Public Overridable Property section_document_codes As Dictionary(Of Integer, List(Of String))
            Public Overridable Property crosslisted_sections As Dictionary(Of Integer, List(Of Int32))
        End Class
    End Namespace
End Namespace

VB.NET SectionsAdminRequest 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/Admin/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<SectionsAdminResponse 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>
  <crosslisted_sections xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintArrayOfintty7Ep6D1>
      <d2p1:Key>0</d2p1:Key>
      <d2p1:Value>
        <d2p1:int>0</d2p1:int>
      </d2p1:Value>
    </d2p1:KeyValueOfintArrayOfintty7Ep6D1>
  </crosslisted_sections>
  <locations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </locations>
  <reporting_term>String</reporting_term>
  <section_document_codes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintArrayOfstringty7Ep6D1>
      <d2p1:Key>0</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>String</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfintArrayOfstringty7Ep6D1>
  </section_document_codes>
  <section_instructors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintArrayOfInstructorResponsezpaGewPN>
      <d2p1:Key>0</d2p1:Key>
      <d2p1:Value>
        <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>
                  <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>
          <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>
      </d2p1:Value>
    </d2p1:KeyValueOfintArrayOfInstructorResponsezpaGewPN>
  </section_instructors>
  <section_rates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintArrayOfSectionRateWithAmountResponsezpaGewPN>
      <d2p1:Key>0</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:KeyValueOfintArrayOfSectionRateWithAmountResponsezpaGewPN>
  </section_rates>
  <section_refund_schedules xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintArrayOfSectionRefundScheduleResponsezpaGewPN>
      <d2p1:Key>0</d2p1:Key>
      <d2p1:Value>
        <SectionRefundScheduleResponse>
          <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>
          <end_date>0001-01-01T00:00:00</end_date>
          <percentage>0</percentage>
          <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>
          <start_date>0001-01-01T00:00:00</start_date>
          <title>String</title>
          <uuid>String</uuid>
        </SectionRefundScheduleResponse>
      </d2p1:Value>
    </d2p1:KeyValueOfintArrayOfSectionRefundScheduleResponsezpaGewPN>
  </section_refund_schedules>
  <sections>
    <SectionAdminResponse>
      <added_by>String</added_by>
      <added_date>0001-01-01T00:00:00</added_date>
      <additional_fee_amount>0</additional_fee_amount>
      <audit_increments>0</audit_increments>
      <capacity>0</capacity>
      <changed_by>String</changed_by>
      <changed_date>0001-01-01T00:00:00</changed_date>
      <course_id>0</course_id>
      <course_name>String</course_name>
      <credit_increments>0</credit_increments>
      <current_status>String</current_status>
      <distance_ed_materials>String</distance_ed_materials>
      <end_date>0001-01-01T00:00:00</end_date>
      <end_times>String</end_times>
      <first_meeting_date>0001-01-01T00:00:00</first_meeting_date>
      <flat_fee_amount>0</flat_fee_amount>
      <has_special_requirements>false</has_special_requirements>
      <is_audio>false</is_audio>
      <is_evening>false</is_evening>
      <is_oncampus>false</is_oncampus>
      <is_pass_fail>false</is_pass_fail>
      <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>String</location>
      <max_audits>0</max_audits>
      <max_credits>0</max_credits>
      <meeting_days>String</meeting_days>
      <min_audits>0</min_audits>
      <min_credits>0</min_credits>
      <override_add_end_date>0001-01-01T00:00:00</override_add_end_date>
      <override_add_start_date>0001-01-01T00:00:00</override_add_start_date>
      <override_course_description>String</override_course_description>
      <override_drop_end_date>0001-01-01T00:00:00</override_drop_end_date>
      <override_drop_start_date>0001-01-01T00:00:00</override_drop_start_date>
      <override_grading_end_date>0001-01-01T00:00:00</override_grading_end_date>
      <override_registration_end_date>0001-01-01T00:00:00</override_registration_end_date>
      <override_registration_start_date>0001-01-01T00:00:00</override_registration_start_date>
      <pretty_title>String</pretty_title>
      <reporting_term>String</reporting_term>
      <reporting_year>0</reporting_year>
      <room>String</room>
      <section_code>String</section_code>
      <section_id>0</section_id>
      <special_requirements>String</special_requirements>
      <start_date>0001-01-01T00:00:00</start_date>
      <start_times>String</start_times>
      <term>String</term>
      <timestamp>0001-01-01T00:00:00</timestamp>
      <title>String</title>
      <uuid>String</uuid>
    </SectionAdminResponse>
  </sections>
</SectionsAdminResponse>