Required permission: | CreatePayments |
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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<FinancePayMyTuitionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<hash>String</hash>
<payload>
<FinancePayMyTuitionPayloadRequest>
<AcademicPeriodGUID>String</AcademicPeriodGUID>
<Currency>String</Currency>
<Id>String</Id>
<PaymentType>String</PaymentType>
<StudentGuid>String</StudentGuid>
<StudentResidenceType>String</StudentResidenceType>
<amount>String</amount>
<comments>String</comments>
<paidOn>String</paidOn>
</FinancePayMyTuitionPayloadRequest>
</payload>
<stamp>String</stamp>
</FinancePayMyTuitionRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <FinancePayStudentAccountByCardResponse 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> <success>false</success> </FinancePayStudentAccountByCardResponse>