Required role: | REGISUserRole |
POST | /Registration/Unauthenticated/{reporting_term}/{transaction_uuid}/Update |
---|
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 UnauthenticatedPersonResponse:
response_status: Optional[ResponseStatus] = None
regent_id: Optional[int] = None
reporting_term: Optional[str] = None
survey: Optional[str] = None
friend_referral: Optional[str] = None
other_referral: Optional[str] = None
is_returning: bool = False
is_applying: bool = False
is_landlord: bool = False
postsecondary_education_level: int = 0
uuid: Optional[str] = None
regent_login: Optional[str] = None
first_name: Optional[str] = None
middle_name: Optional[str] = None
last_name: Optional[str] = None
preferred_name: Optional[str] = None
birth_name: Optional[str] = None
spouse_name: Optional[str] = None
addr1: Optional[str] = None
addr2: Optional[str] = None
country: Optional[str] = None
state: Optional[str] = None
city: Optional[str] = None
code: Optional[str] = None
phone_home: Optional[str] = None
phone_cell: Optional[str] = None
phone_bus: Optional[str] = None
email: Optional[str] = None
prefix: Optional[str] = None
dob: Optional[datetime.datetime] = None
citizenship: Optional[str] = None
citizenship_other: Optional[str] = None
permanent_resident: Optional[str] = None
denomination: Optional[str] = None
occupation: Optional[str] = None
ethnicity: Optional[str] = None
gender: Optional[str] = None
marital_status: Optional[str] = None
deceased_date: Optional[datetime.datetime] = None
added_by: Optional[str] = None
added_date: Optional[datetime.datetime] = None
last_changed_by: Optional[str] = None
last_changed_date: Optional[datetime.datetime] = None
addr_last_changed_by: Optional[str] = None
addr_last_changed_date: Optional[datetime.datetime] = None
timestamp: datetime.datetime = datetime.datetime(1, 1, 1)
submitted_datetime: Optional[datetime.datetime] = None
submitted_by_unauthenticated_person_id: Optional[int] = None
authorized_datetime: Optional[datetime.datetime] = None
authorized_by_person_id: Optional[int] = None
archived_datetime: Optional[datetime.datetime] = None
archived_by_person_id: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UnauthenticatedStudentSectionRegistrationResponse:
section_uuid: Optional[str] = None
student_section_uuid: Optional[str] = None
course_name: Optional[str] = None
section_code: Optional[str] = None
course_title: Optional[str] = None
amount: Decimal = decimal.Decimal(0)
is_oncampus: bool = False
is_audit: bool = False
is_provisional: bool = False
is_missing_requisites: bool = False
is_other_restriction: bool = False
added_date: Optional[datetime.datetime] = None
added_by_person_id: Optional[int] = None
changed_date: Optional[datetime.datetime] = None
changed_by_person_id: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UnauthenticatedRegistrationTransactionResponse:
response_status: Optional[ResponseStatus] = None
transaction_uuid: Optional[str] = None
notes_json: Optional[str] = None
credit_hours: Decimal = decimal.Decimal(0)
audit_hours: Decimal = decimal.Decimal(0)
started_datetime: datetime.datetime = datetime.datetime(1, 1, 1)
archived_datetime: Optional[datetime.datetime] = None
submitted_datetime: Optional[datetime.datetime] = None
authorized_datetime: Optional[datetime.datetime] = None
person: Optional[UnauthenticatedPersonResponse] = None
registrations: Optional[List[UnauthenticatedStudentSectionRegistrationResponse]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UnauthenticatedRegistrationTransactionUpdateRequest:
transaction_uuid: Optional[str] = None
reporting_term: Optional[str] = None
is_authorized: bool = False
is_archived: bool = False
authorizing_uuid: Optional[str] = None
Python UnauthenticatedRegistrationTransactionUpdateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Registration/Unauthenticated/{reporting_term}/{transaction_uuid}/Update HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UnauthenticatedRegistrationTransactionUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<authorizing_uuid>String</authorizing_uuid>
<is_archived>false</is_archived>
<is_authorized>false</is_authorized>
<reporting_term>String</reporting_term>
<transaction_uuid>String</transaction_uuid>
</UnauthenticatedRegistrationTransactionUpdateRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <UnauthenticatedRegistrationTransactionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <archived_datetime>0001-01-01T00:00:00</archived_datetime> <audit_hours>0</audit_hours> <authorized_datetime>0001-01-01T00:00:00</authorized_datetime> <credit_hours>0</credit_hours> <notes_json>String</notes_json> <person> <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types"> <d3p1:ErrorCode>String</d3p1:ErrorCode> <d3p1:Message>String</d3p1:Message> <d3p1:StackTrace>String</d3p1:StackTrace> <d3p1:Errors> <d3p1:ResponseError> <d3p1:ErrorCode>String</d3p1:ErrorCode> <d3p1:FieldName>String</d3p1:FieldName> <d3p1:Message>String</d3p1:Message> <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:KeyValueOfstringstring> <d6p1:Key>String</d6p1:Key> <d6p1:Value>String</d6p1:Value> </d6p1:KeyValueOfstringstring> </d3p1:Meta> </d3p1:ResponseError> </d3p1:Errors> <d3p1: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> </d3p1:Meta> </ResponseStatus> <added_by>String</added_by> <added_date>0001-01-01T00:00:00</added_date> <addr1>String</addr1> <addr2>String</addr2> <addr_last_changed_by>String</addr_last_changed_by> <addr_last_changed_date>0001-01-01T00:00:00</addr_last_changed_date> <archived_by_person_id>0</archived_by_person_id> <archived_datetime>0001-01-01T00:00:00</archived_datetime> <authorized_by_person_id>0</authorized_by_person_id> <authorized_datetime>0001-01-01T00:00:00</authorized_datetime> <birth_name>String</birth_name> <citizenship>String</citizenship> <citizenship_other>String</citizenship_other> <city>String</city> <code>String</code> <country>String</country> <deceased_date>0001-01-01T00:00:00</deceased_date> <denomination>String</denomination> <dob>0001-01-01T00:00:00</dob> <email>String</email> <ethnicity>String</ethnicity> <first_name>String</first_name> <friend_referral>String</friend_referral> <gender>String</gender> <is_applying>false</is_applying> <is_landlord>false</is_landlord> <is_returning>false</is_returning> <last_changed_by>String</last_changed_by> <last_changed_date>0001-01-01T00:00:00</last_changed_date> <last_name>String</last_name> <marital_status>String</marital_status> <middle_name>String</middle_name> <occupation>String</occupation> <other_referral>String</other_referral> <permanent_resident>String</permanent_resident> <phone_bus>String</phone_bus> <phone_cell>String</phone_cell> <phone_home>String</phone_home> <postsecondary_education_level>0</postsecondary_education_level> <preferred_name>String</preferred_name> <prefix>String</prefix> <regent_id>0</regent_id> <regent_login>String</regent_login> <reporting_term>String</reporting_term> <spouse_name>String</spouse_name> <state>String</state> <submitted_by_unauthenticated_person_id>0</submitted_by_unauthenticated_person_id> <submitted_datetime>0001-01-01T00:00:00</submitted_datetime> <survey>String</survey> <timestamp>0001-01-01T00:00:00</timestamp> <uuid>String</uuid> </person> <registrations> <UnauthenticatedStudentSectionRegistrationResponse> <added_by_person_id>0</added_by_person_id> <added_date>0001-01-01T00:00:00</added_date> <amount>0</amount> <changed_by_person_id>0</changed_by_person_id> <changed_date>0001-01-01T00:00:00</changed_date> <course_name>String</course_name> <course_title>String</course_title> <is_audit>false</is_audit> <is_missing_requisites>false</is_missing_requisites> <is_oncampus>false</is_oncampus> <is_other_restriction>false</is_other_restriction> <is_provisional>false</is_provisional> <section_code>String</section_code> <section_uuid>String</section_uuid> <student_section_uuid>String</student_section_uuid> </UnauthenticatedStudentSectionRegistrationResponse> </registrations> <started_datetime>0001-01-01T00:00:00</started_datetime> <submitted_datetime>0001-01-01T00:00:00</submitted_datetime> <transaction_uuid>String</transaction_uuid> </UnauthenticatedRegistrationTransactionResponse>