regis

<back to all web services

CourseUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Courses/Admin/Update/{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 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 CourseUpdateRequest:
    id: int = 0
    course_name: Optional[str] = None
    title: Optional[str] = None
    pretty_title: Optional[str] = None
    course_description: Optional[str] = None
    is_active: bool = False
    course_requirements: Optional[List[CourseRequirementResponse]] = None
    authorizing_uuid: Optional[str] = None

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

<CourseUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <course_description>String</course_description>
  <course_name>String</course_name>
  <course_requirements xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
    <d2p1:CourseRequirementResponse>
      <d2p1:course_id>0</d2p1:course_id>
      <d2p1:is_corequisite>false</d2p1:is_corequisite>
      <d2p1:is_prerequisite>false</d2p1:is_prerequisite>
      <d2p1:required_course_id>0</d2p1:required_course_id>
      <d2p1:requirement_group>0</d2p1:requirement_group>
      <d2p1:timestamp>0001-01-01T00:00:00</d2p1:timestamp>
    </d2p1:CourseRequirementResponse>
  </course_requirements>
  <id>0</id>
  <is_active>false</is_active>
  <pretty_title>String</pretty_title>
  <title>String</title>
</CourseUpdateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>