regis

SectionsAdminRequest

**Requires Authentication**
Required role:	REGISUserRole

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SectionAdminResponse:
    uuid: Optional[str] = None
    section_id: int = 0
    course_id: Optional[int] = None
    course_name: Optional[str] = None
    min_credits: Optional[Decimal] = None
    max_credits: Optional[Decimal] = None
    credit_increments: Optional[Decimal] = None
    min_audits: Optional[Decimal] = None
    max_audits: Optional[Decimal] = None
    audit_increments: Optional[Decimal] = None
    section_code: Optional[str] = None
    title: Optional[str] = None
    pretty_title: Optional[str] = None
    override_course_description: Optional[str] = None
    current_status: Optional[str] = None
    location: Optional[str] = None
    room: Optional[str] = None
    is_audio: bool = False
    is_oncampus: bool = False
    distance_ed_materials: Optional[str] = None
    start_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None
    first_meeting_date: Optional[datetime.datetime] = None
    last_meeting_date: Optional[datetime.datetime] = None
    meeting_days: Optional[str] = None
    start_times: Optional[str] = None
    end_times: Optional[str] = None
    is_pass_fail: bool = False
    is_weekend: bool = False
    is_weekday: bool = False
    is_evening: bool = False
    is_waitlist: bool = False
    has_special_requirements: bool = False
    special_requirements: Optional[str] = None
    is_unlisted: bool = False
    capacity: Optional[int] = None
    flat_fee_amount: Optional[Decimal] = None
    additional_fee_amount: Optional[Decimal] = None
    override_registration_start_date: Optional[datetime.datetime] = None
    override_registration_end_date: Optional[datetime.datetime] = None
    override_add_start_date: Optional[datetime.datetime] = None
    override_add_end_date: Optional[datetime.datetime] = None
    override_drop_start_date: Optional[datetime.datetime] = None
    override_drop_end_date: Optional[datetime.datetime] = None
    override_grading_end_date: Optional[datetime.datetime] = None
    term: Optional[str] = None
    reporting_term: Optional[str] = None
    reporting_year: int = 0
    added_date: Optional[datetime.datetime] = None
    added_by: Optional[str] = None
    changed_date: Optional[datetime.datetime] = None
    changed_by: Optional[str] = None
    timestamp: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SectionsAdminResponse:
    response_status: Optional[ResponseStatus] = None
    reporting_term: Optional[str] = None
    sections: Optional[List[SectionAdminResponse]] = None
    section_rates: Optional[Dict[int, List[SectionRateWithAmountResponse]]] = None
    section_refund_schedules: Optional[Dict[int, List[SectionRefundScheduleResponse]]] = None
    locations: Optional[List[str]] = None
    section_instructors: Optional[Dict[int, List[InstructorResponse]]] = None
    section_document_codes: Optional[Dict[int, List[str]]] = None
    crosslisted_sections: Optional[Dict[int, List[int]]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SectionsAdminRequest:
    reporting_term: Optional[str] = None

Python 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>