regis

<back to all web services

CourseRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Course/{id}
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 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 CourseRequest:
    id: int = 0

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

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

<CourseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <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>