regis

<back to all web services

UnauthenticatedRegistrationInProgressSummaryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
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 .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 /Registration/InProgressSummaryForUnauthenticatedPerson/{uuid}/Term/{reporting_term}/{transaction_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UnauthenticatedRegistrationInProgressSummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <audio_only>false</audio_only>
  <reporting_term>String</reporting_term>
  <transaction_uuid>String</transaction_uuid>
  <uuid>String</uuid>
</UnauthenticatedRegistrationInProgressSummaryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegistrationInProgressSummaryResponse 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>
  <amountOwing>0</amountOwing>
  <completedDocuments>
    <RegistrationDocumentResponse>
      <added_date>0001-01-01T00:00:00</added_date>
      <changed_date>0001-01-01T00:00:00</changed_date>
      <concentration>String</concentration>
      <course_name>String</course_name>
      <course_title>String</course_title>
      <document_code>String</document_code>
      <document_description>String</document_description>
      <document_json>String</document_json>
      <document_name>String</document_name>
      <email>String</email>
      <first_name>String</first_name>
      <gender>String</gender>
      <last_name>String</last_name>
      <program>String</program>
      <regent_id>0</regent_id>
      <reporting_term>String</reporting_term>
      <section_uuid>String</section_uuid>
      <uuid>String</uuid>
    </RegistrationDocumentResponse>
  </completedDocuments>
  <isLate>false</isLate>
  <mustPayBeforeRegistering>false</mustPayBeforeRegistering>
  <numberOfStudentSections>0</numberOfStudentSections>
  <regent_id>0</regent_id>
  <reporting_term>String</reporting_term>
  <requiredDocuments>
    <RegistrationDocumentResponse>
      <added_date>0001-01-01T00:00:00</added_date>
      <changed_date>0001-01-01T00:00:00</changed_date>
      <concentration>String</concentration>
      <course_name>String</course_name>
      <course_title>String</course_title>
      <document_code>String</document_code>
      <document_description>String</document_description>
      <document_json>String</document_json>
      <document_name>String</document_name>
      <email>String</email>
      <first_name>String</first_name>
      <gender>String</gender>
      <last_name>String</last_name>
      <program>String</program>
      <regent_id>0</regent_id>
      <reporting_term>String</reporting_term>
      <section_uuid>String</section_uuid>
      <uuid>String</uuid>
    </RegistrationDocumentResponse>
  </requiredDocuments>
  <transaction_uuid>String</transaction_uuid>
  <uuid>String</uuid>
</RegistrationInProgressSummaryResponse>