regis

<back to all web services

TermStatementRequest

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

POST /TermStatements/{uuid}/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	reporting_term: String,
	authorizing_uuid: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	regent_id: 0,
	uuid: String,
	name: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	reporting_term: String,
	reporting_term_start_date: 0001-01-01,
	reporting_term_end_date: 0001-01-01,
	academic_program: String,
	total_term_payments: 0,
	total_term_charges: 0,
	total_term_taxes: 0,
	registrations: 
	[
		{
			course_name: String,
			title: String,
			section_code: String,
			amount: 0,
			is_audit: False,
			meeting_days: String,
			times: String,
			room: String,
			instructor: String,
			status: String,
			cost: 0,
			start_date: 0001-01-01,
			end_date: 0001-01-01
		}
	],
	charges: 
	[
		{
			date: 0001-01-01,
			code: String,
			description: String,
			is_financial_aid: False,
			charge: 0
		}
	]
}