Required role: | REGISUserRole |
POST | /Sections/{uuid}/Documents |
---|
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 DocumentResponse:
code: Optional[str] = None
document_name: Optional[str] = None
document_description: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SectionDocumentsResponse:
uuid: Optional[str] = None
course_name: Optional[str] = None
title: Optional[str] = None
term: Optional[str] = None
reporting_term: Optional[str] = None
assigned_documents: Optional[List[DocumentResponse]] = None
available_documents: Optional[List[DocumentResponse]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SectionDocumentsRequest:
uuid: Optional[str] = None
Python SectionDocumentsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Sections/{uuid}/Documents HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { uuid: String, course_name: String, title: String, term: String, reporting_term: String, assigned_documents: [ { code: String, document_name: String, document_description: String } ], available_documents: [ { code: String, document_name: String, document_description: String } ] }