regis

CourseRequirementsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Course/{id}/Requirements

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 CourseRequirementResponse:
    course_id: int = 0
    required_course_id: int = 0
    requirement_group: int = 0
    is_prerequisite: bool = False
    is_corequisite: bool = False
    timestamp: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourseResponse:
    id: Optional[int] = None
    course_name: Optional[str] = None
    title: Optional[str] = None
    pretty_title: Optional[str] = None
    course_description: Optional[str] = None
    is_active: bool = False
    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 CourseRequirementsResponse:
    response_status: Optional[ResponseStatus] = None
    course_id: int = 0
    requirements: Optional[List[CourseRequirementResponse]] = None
    courses: Optional[List[CourseResponse]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourseRequirementsRequest:
    id: int = 0

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

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

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

<CourseRequirementsResponse 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>
  <course_id>0</course_id>
  <courses>
    <CourseResponse>
      <added_by>String</added_by>
      <added_date>0001-01-01T00:00:00</added_date>
      <changed_by>String</changed_by>
      <changed_date>0001-01-01T00:00:00</changed_date>
      <course_description>String</course_description>
      <course_name>String</course_name>
      <id>0</id>
      <is_active>false</is_active>
      <pretty_title>String</pretty_title>
      <timestamp>0001-01-01T00:00:00</timestamp>
      <title>String</title>
    </CourseResponse>
  </courses>
  <requirements>
    <CourseRequirementResponse>
      <course_id>0</course_id>
      <is_corequisite>false</is_corequisite>
      <is_prerequisite>false</is_prerequisite>
      <required_course_id>0</required_course_id>
      <requirement_group>0</requirement_group>
      <timestamp>0001-01-01T00:00:00</timestamp>
    </CourseRequirementResponse>
  </requirements>
</CourseRequirementsResponse>