Required role: | REGISUserRole |
POST | /Registration/InProgressSummaryForUnauthenticatedPerson/{uuid}/Term/{reporting_term}/{transaction_uuid} |
---|
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 RegistrationDocumentResponse:
uuid: Optional[str] = None
regent_id: int = 0
first_name: Optional[str] = None
last_name: Optional[str] = None
gender: Optional[str] = None
email: Optional[str] = None
program: Optional[str] = None
concentration: Optional[str] = None
section_uuid: Optional[str] = None
course_name: Optional[str] = None
course_title: Optional[str] = None
reporting_term: Optional[str] = None
document_code: Optional[str] = None
document_json: Optional[str] = None
document_name: Optional[str] = None
document_description: Optional[str] = None
added_date: Optional[datetime.datetime] = None
changed_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegistrationInProgressSummaryResponse:
response_status: Optional[ResponseStatus] = None
transaction_uuid: Optional[str] = None
regent_id: int = 0
uuid: Optional[str] = None
reporting_term: Optional[str] = None
number_of_student_sections: int = 0
amount_owing: Decimal = decimal.Decimal(0)
must_pay_before_registering: bool = False
required_documents: Optional[List[RegistrationDocumentResponse]] = None
completed_documents: Optional[List[RegistrationDocumentResponse]] = None
is_late: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UnauthenticatedRegistrationInProgressSummaryRequest:
uuid: Optional[str] = None
transaction_uuid: Optional[str] = None
reporting_term: Optional[str] = None
audio_only: bool = False
Python UnauthenticatedRegistrationInProgressSummaryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Registration/InProgressSummaryForUnauthenticatedPerson/{uuid}/Term/{reporting_term}/{transaction_uuid} HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"uuid":"String","transaction_uuid":"String","reporting_term":"String","audio_only":false}
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"transaction_uuid":"String","regent_id":0,"uuid":"String","reporting_term":"String","numberOfStudentSections":0,"amountOwing":0,"mustPayBeforeRegistering":false,"requiredDocuments":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"completedDocuments":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"isLate":false}