regis

<back to all web services

SectionsTimetableRequest

Requires Authentication
Required permission:ReadSections
The following routes are available for this service:
POST/Sections/Timetable/{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 SectionTimetableNoteResponse:
    heading: Optional[str] = None
    body: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SectionTimetableResponse:
    time: Optional[str] = None
    sort_time: Optional[int] = None
    course: Optional[str] = None
    course_slug: Optional[str] = None
    desc: Optional[str] = None
    instructors: Optional[List[SectionTimetableInstructorResponse]] = None
    registration_info: Optional[str] = None
    room: Optional[str] = None
    credit_minimum: Decimal = decimal.Decimal(0)
    credit_maximum: Decimal = decimal.Decimal(0)
    audit_minimum: Decimal = decimal.Decimal(0)
    audit_maximum: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SectionsTimetableResponse:
    response_status: Optional[ResponseStatus] = None
    term: Optional[str] = None
    notes: Optional[List[SectionTimetableNoteResponse]] = None
    monday: Optional[List[SectionTimetableResponse]] = None
    tuesday: Optional[List[SectionTimetableResponse]] = None
    wednesday: Optional[List[SectionTimetableResponse]] = None
    thursday: Optional[List[SectionTimetableResponse]] = None
    friday: Optional[List[SectionTimetableResponse]] = None
    saturday: Optional[List[SectionTimetableResponse]] = None
    sunday: Optional[List[SectionTimetableResponse]] = None


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

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

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

<SectionsTimetableResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <Friday>
    <SectionTimetableResponse>
      <AuditMaximum>0</AuditMaximum>
      <AuditMinimum>0</AuditMinimum>
      <Course>String</Course>
      <CourseSlug>String</CourseSlug>
      <CreditMaximum>0</CreditMaximum>
      <CreditMinimum>0</CreditMinimum>
      <Desc>String</Desc>
      <Instructors>
        <SectionTimetableInstructorResponse>
          <InstructorName>String</InstructorName>
          <InstructorSlug>String</InstructorSlug>
        </SectionTimetableInstructorResponse>
      </Instructors>
      <RegistrationInfo>String</RegistrationInfo>
      <Room>String</Room>
      <SortTime>0</SortTime>
      <Time>String</Time>
    </SectionTimetableResponse>
  </Friday>
  <Monday>
    <SectionTimetableResponse>
      <AuditMaximum>0</AuditMaximum>
      <AuditMinimum>0</AuditMinimum>
      <Course>String</Course>
      <CourseSlug>String</CourseSlug>
      <CreditMaximum>0</CreditMaximum>
      <CreditMinimum>0</CreditMinimum>
      <Desc>String</Desc>
      <Instructors>
        <SectionTimetableInstructorResponse>
          <InstructorName>String</InstructorName>
          <InstructorSlug>String</InstructorSlug>
        </SectionTimetableInstructorResponse>
      </Instructors>
      <RegistrationInfo>String</RegistrationInfo>
      <Room>String</Room>
      <SortTime>0</SortTime>
      <Time>String</Time>
    </SectionTimetableResponse>
  </Monday>
  <Notes>
    <SectionTimetableNoteResponse>
      <Body>String</Body>
      <Heading>String</Heading>
    </SectionTimetableNoteResponse>
  </Notes>
  <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>
  <Saturday>
    <SectionTimetableResponse>
      <AuditMaximum>0</AuditMaximum>
      <AuditMinimum>0</AuditMinimum>
      <Course>String</Course>
      <CourseSlug>String</CourseSlug>
      <CreditMaximum>0</CreditMaximum>
      <CreditMinimum>0</CreditMinimum>
      <Desc>String</Desc>
      <Instructors>
        <SectionTimetableInstructorResponse>
          <InstructorName>String</InstructorName>
          <InstructorSlug>String</InstructorSlug>
        </SectionTimetableInstructorResponse>
      </Instructors>
      <RegistrationInfo>String</RegistrationInfo>
      <Room>String</Room>
      <SortTime>0</SortTime>
      <Time>String</Time>
    </SectionTimetableResponse>
  </Saturday>
  <Sunday>
    <SectionTimetableResponse>
      <AuditMaximum>0</AuditMaximum>
      <AuditMinimum>0</AuditMinimum>
      <Course>String</Course>
      <CourseSlug>String</CourseSlug>
      <CreditMaximum>0</CreditMaximum>
      <CreditMinimum>0</CreditMinimum>
      <Desc>String</Desc>
      <Instructors>
        <SectionTimetableInstructorResponse>
          <InstructorName>String</InstructorName>
          <InstructorSlug>String</InstructorSlug>
        </SectionTimetableInstructorResponse>
      </Instructors>
      <RegistrationInfo>String</RegistrationInfo>
      <Room>String</Room>
      <SortTime>0</SortTime>
      <Time>String</Time>
    </SectionTimetableResponse>
  </Sunday>
  <Term>String</Term>
  <Thursday>
    <SectionTimetableResponse>
      <AuditMaximum>0</AuditMaximum>
      <AuditMinimum>0</AuditMinimum>
      <Course>String</Course>
      <CourseSlug>String</CourseSlug>
      <CreditMaximum>0</CreditMaximum>
      <CreditMinimum>0</CreditMinimum>
      <Desc>String</Desc>
      <Instructors>
        <SectionTimetableInstructorResponse>
          <InstructorName>String</InstructorName>
          <InstructorSlug>String</InstructorSlug>
        </SectionTimetableInstructorResponse>
      </Instructors>
      <RegistrationInfo>String</RegistrationInfo>
      <Room>String</Room>
      <SortTime>0</SortTime>
      <Time>String</Time>
    </SectionTimetableResponse>
  </Thursday>
  <Tuesday>
    <SectionTimetableResponse>
      <AuditMaximum>0</AuditMaximum>
      <AuditMinimum>0</AuditMinimum>
      <Course>String</Course>
      <CourseSlug>String</CourseSlug>
      <CreditMaximum>0</CreditMaximum>
      <CreditMinimum>0</CreditMinimum>
      <Desc>String</Desc>
      <Instructors>
        <SectionTimetableInstructorResponse>
          <InstructorName>String</InstructorName>
          <InstructorSlug>String</InstructorSlug>
        </SectionTimetableInstructorResponse>
      </Instructors>
      <RegistrationInfo>String</RegistrationInfo>
      <Room>String</Room>
      <SortTime>0</SortTime>
      <Time>String</Time>
    </SectionTimetableResponse>
  </Tuesday>
  <Wednesday>
    <SectionTimetableResponse>
      <AuditMaximum>0</AuditMaximum>
      <AuditMinimum>0</AuditMinimum>
      <Course>String</Course>
      <CourseSlug>String</CourseSlug>
      <CreditMaximum>0</CreditMaximum>
      <CreditMinimum>0</CreditMinimum>
      <Desc>String</Desc>
      <Instructors>
        <SectionTimetableInstructorResponse>
          <InstructorName>String</InstructorName>
          <InstructorSlug>String</InstructorSlug>
        </SectionTimetableInstructorResponse>
      </Instructors>
      <RegistrationInfo>String</RegistrationInfo>
      <Room>String</Room>
      <SortTime>0</SortTime>
      <Time>String</Time>
    </SectionTimetableResponse>
  </Wednesday>
</SectionsTimetableResponse>