regis

<back to all web services

FinancePayMyTuitionRequest

Requires Authentication
Required permission:CreatePayments
The following routes are available for this service:
POST/Finance/PayMyTuition
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 FinancePayStudentAccountByCardResponse:
    response_status: Optional[ResponseStatus] = None
    success: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancePayMyTuitionPayloadRequest:
    student_guid: Optional[str] = None
    academic_period_g_u_i_d: Optional[str] = None
    payment_type: Optional[str] = None
    paid_on: Optional[str] = None
    comments: Optional[str] = None
    amount: Optional[str] = None
    currency: Optional[str] = None
    id: Optional[str] = None
    student_residence_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancePayMyTuitionRequest:
    payload: Optional[List[FinancePayMyTuitionPayloadRequest]] = None
    stamp: Optional[str] = None
    hash: Optional[str] = None

Python FinancePayMyTuitionRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Finance/PayMyTuition HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	payload: 
	[
		{
			studentGuid: String,
			academicPeriodGUID: String,
			paymentType: String,
			paidOn: String,
			comments: String,
			amount: String,
			currency: String,
			id: String,
			studentResidenceType: String
		}
	],
	stamp: String,
	hash: 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
		}
	},
	success: False
}