regis

<back to all web services

UnauthenticatedRegistrationTransactionRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/Unauthenticated/{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 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 UnauthenticatedRegistrationTransactionRequest:
    reporting_term: Optional[str] = None
    transaction_uuid: Optional[str] = None
    authorizing_uuid: Optional[str] = None

Python UnauthenticatedRegistrationTransactionRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

{"reporting_term":"String","transaction_uuid":"String","authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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","notes_json":"String","credit_hours":0,"audit_hours":0,"started_datetime":"0001-01-01T00:00:00.0000000","archived_datetime":"0001-01-01T00:00:00.0000000","submitted_datetime":"0001-01-01T00:00:00.0000000","authorized_datetime":"0001-01-01T00:00:00.0000000","person":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"reporting_term":"String","survey":"String","friend_referral":"String","other_referral":"String","is_returning":false,"is_applying":false,"is_landlord":false,"postsecondary_education_level":0,"uuid":"String","regent_login":"String","first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","spouse_name":"String","addr1":"String","addr2":"String","country":"String","state":"String","city":"String","code":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_other":"String","permanent_resident":"String","denomination":"String","occupation":"String","ethnicity":"String","gender":"String","marital_status":"String","deceased_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","last_changed_by":"String","last_changed_date":"0001-01-01T00:00:00.0000000","addr_last_changed_by":"String","addr_last_changed_date":"0001-01-01T00:00:00.0000000","timestamp":"0001-01-01T00:00:00.0000000","submitted_datetime":"0001-01-01T00:00:00.0000000","submitted_by_unauthenticated_person_id":0,"authorized_datetime":"0001-01-01T00:00:00.0000000","authorized_by_person_id":0,"archived_datetime":"0001-01-01T00:00:00.0000000","archived_by_person_id":0},"registrations":[{"section_uuid":"String","student_section_uuid":"String","course_name":"String","section_code":"String","course_title":"String","amount":0,"is_oncampus":false,"is_audit":false,"is_provisional":false,"is_missing_requisites":false,"is_other_restriction":false,"added_date":"0001-01-01T00:00:00.0000000","added_by_person_id":0,"changed_date":"0001-01-01T00:00:00.0000000","changed_by_person_id":0}]}