regis

TermStatementRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/TermStatements/{uuid}/{reporting_term}

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 TermStatementRegistrationResponse:
    course_name: Optional[str] = None
    title: Optional[str] = None
    section_code: Optional[str] = None
    amount: Decimal = decimal.Decimal(0)
    is_audit: bool = False
    meeting_days: Optional[str] = None
    times: Optional[str] = None
    room: Optional[str] = None
    instructor: Optional[str] = None
    status: Optional[str] = None
    cost: Decimal = decimal.Decimal(0)
    start_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TermStatementChargesResponse:
    date: datetime.datetime = datetime.datetime(1, 1, 1)
    code: Optional[str] = None
    description: Optional[str] = None
    is_financial_aid: bool = False
    charge: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TermStatementResponse:
    response_status: Optional[ResponseStatus] = None
    regent_id: int = 0
    uuid: Optional[str] = None
    name: Optional[str] = None
    addr1: Optional[str] = None
    addr2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    country: Optional[str] = None
    code: Optional[str] = None
    reporting_term: Optional[str] = None
    reporting_term_start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    reporting_term_end_date: datetime.datetime = datetime.datetime(1, 1, 1)
    academic_program: Optional[str] = None
    total_term_payments: Decimal = decimal.Decimal(0)
    total_term_charges: Decimal = decimal.Decimal(0)
    total_term_taxes: Decimal = decimal.Decimal(0)
    registrations: Optional[List[TermStatementRegistrationResponse]] = None
    charges: Optional[List[TermStatementChargesResponse]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TermStatementRequest:
    uuid: Optional[str] = None
    reporting_term: Optional[str] = None
    authorizing_uuid: Optional[str] = None

Python TermStatementRequest 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 /TermStatements/{uuid}/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TermStatementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <reporting_term>String</reporting_term>
  <uuid>String</uuid>
</TermStatementRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TermStatementResponse 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>
  <academic_program>String</academic_program>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <charges>
    <TermStatementChargesResponse>
      <charge>0</charge>
      <code>String</code>
      <date>0001-01-01T00:00:00</date>
      <description>String</description>
      <is_financial_aid>false</is_financial_aid>
    </TermStatementChargesResponse>
  </charges>
  <city>String</city>
  <code>String</code>
  <country>String</country>
  <name>String</name>
  <regent_id>0</regent_id>
  <registrations>
    <TermStatementRegistrationResponse>
      <amount>0</amount>
      <cost>0</cost>
      <course_name>String</course_name>
      <end_date>0001-01-01T00:00:00</end_date>
      <instructor>String</instructor>
      <is_audit>false</is_audit>
      <meeting_days>String</meeting_days>
      <room>String</room>
      <section_code>String</section_code>
      <start_date>0001-01-01T00:00:00</start_date>
      <status>String</status>
      <times>String</times>
      <title>String</title>
    </TermStatementRegistrationResponse>
  </registrations>
  <reporting_term>String</reporting_term>
  <reporting_term_end_date>0001-01-01T00:00:00</reporting_term_end_date>
  <reporting_term_start_date>0001-01-01T00:00:00</reporting_term_start_date>
  <state>String</state>
  <total_term_charges>0</total_term_charges>
  <total_term_payments>0</total_term_payments>
  <total_term_taxes>0</total_term_taxes>
  <uuid>String</uuid>
</TermStatementResponse>