regis

<back to all web services

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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"id":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"course_id":0,"requirements":[{"course_id":0,"required_course_id":0,"requirement_group":0,"is_prerequisite":false,"is_corequisite":false,"timestamp":"0001-01-01T00:00:00.0000000"}],"courses":[{"id":0,"course_name":"String","title":"String","pretty_title":"String","course_description":"String","is_active":false,"added_date":"0001-01-01T00:00:00.0000000","added_by":"String","changed_date":"0001-01-01T00:00:00.0000000","changed_by":"String","timestamp":"0001-01-01T00:00:00.0000000"}]}