| Required role: | REGISUserRole |
| POST | /Finance/AccountLate/{reporting_term}/Jobs/Result |
|---|
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 FinanceAccountLateChargeOutcome:
regent_id: int = 0
status: Optional[str] = None
charge_amount: Optional[Decimal] = None
charge_status: Optional[str] = None
email_status: Optional[str] = None
message: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceAccountLateChargeJobResponse:
response_status: Optional[ResponseStatus] = None
operation_id: Optional[str] = None
reporting_term: Optional[str] = None
calculation_date: datetime.datetime = datetime.datetime(1, 1, 1)
preview_only: bool = False
skip_exact_balance: Optional[Decimal] = None
state: Optional[str] = None
total: Optional[int] = None
current_regent_id: Optional[int] = None
processed: int = 0
succeeded: int = 0
skipped: int = 0
failed: int = 0
created_utc: datetime.datetime = datetime.datetime(1, 1, 1)
updated_utc: datetime.datetime = datetime.datetime(1, 1, 1)
message: Optional[str] = None
report_available: bool = False
outcomes: Optional[List[FinanceAccountLateChargeOutcome]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceAccountLateChargeResponse:
response_status: Optional[ResponseStatus] = None
skip_reason: Optional[str] = None
charge_status: Optional[str] = None
email_status: Optional[str] = None
charge_error: Optional[str] = None
email_error: Optional[str] = None
regent_id: int = 0
first_name: Optional[str] = None
last_name: Optional[str] = None
uuid: Optional[str] = None
has_late_reg_fee: bool = False
amount_owing: Decimal = decimal.Decimal(0)
late_fee: Decimal = decimal.Decimal(0)
interest: Decimal = decimal.Decimal(0)
active_financial_restrictions: Optional[str] = None
new_financial_restriction: Optional[str] = None
last_registration_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceAccountLateChargeJobResultResponse:
response_status: Optional[ResponseStatus] = None
job: Optional[FinanceAccountLateChargeJobResponse] = None
accounts: Optional[List[FinanceAccountLateChargeResponse]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceAccountLateChargeJobResultRequest:
authorizing_uuid: Optional[str] = None
reporting_term: Optional[str] = None
operation_id: Optional[str] = None
Python FinanceAccountLateChargeJobResultRequest 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/AccountLate/{reporting_term}/Jobs/Result HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FinanceAccountLateChargeJobResultRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<authorizing_uuid>String</authorizing_uuid>
<operation_id>00000000-0000-0000-0000-000000000000</operation_id>
<reporting_term>String</reporting_term>
</FinanceAccountLateChargeJobResultRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FinanceAccountLateChargeJobResultResponse 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>
<accounts>
<FinanceAccountLateChargeResponse>
<ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
<d4p1:ErrorCode>String</d4p1:ErrorCode>
<d4p1:Message>String</d4p1:Message>
<d4p1:StackTrace>String</d4p1:StackTrace>
<d4p1:Errors>
<d4p1:ResponseError>
<d4p1:ErrorCode>String</d4p1:ErrorCode>
<d4p1:FieldName>String</d4p1:FieldName>
<d4p1:Message>String</d4p1:Message>
<d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>String</d7p1:Key>
<d7p1:Value>String</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</d4p1:Meta>
</d4p1:ResponseError>
</d4p1:Errors>
<d4p1: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>
</d4p1:Meta>
</ResponseStatus>
<active_financial_restrictions>String</active_financial_restrictions>
<amount_owing>0</amount_owing>
<charge_error>String</charge_error>
<charge_status>String</charge_status>
<email_error>String</email_error>
<email_status>String</email_status>
<first_name>String</first_name>
<has_late_reg_fee>false</has_late_reg_fee>
<interest>0</interest>
<last_name>String</last_name>
<last_registration_date>0001-01-01T00:00:00</last_registration_date>
<late_fee>0</late_fee>
<new_financial_restriction>String</new_financial_restriction>
<regent_id>0</regent_id>
<skip_reason>String</skip_reason>
<uuid>String</uuid>
</FinanceAccountLateChargeResponse>
</accounts>
<job>
<ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:Message>String</d3p1:Message>
<d3p1:StackTrace>String</d3p1:StackTrace>
<d3p1:Errors>
<d3p1:ResponseError>
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:FieldName>String</d3p1:FieldName>
<d3p1:Message>String</d3p1:Message>
<d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d3p1:Meta>
</d3p1:ResponseError>
</d3p1:Errors>
<d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</d3p1:Meta>
</ResponseStatus>
<calculation_date>0001-01-01T00:00:00</calculation_date>
<created_utc>0001-01-01T00:00:00</created_utc>
<current_regent_id>0</current_regent_id>
<failed>0</failed>
<message>String</message>
<operation_id>00000000-0000-0000-0000-000000000000</operation_id>
<outcomes>
<FinanceAccountLateChargeOutcome>
<charge_amount>0</charge_amount>
<charge_status>String</charge_status>
<email_status>String</email_status>
<message>String</message>
<regent_id>0</regent_id>
<status>String</status>
</FinanceAccountLateChargeOutcome>
</outcomes>
<preview_only>false</preview_only>
<processed>0</processed>
<report_available>false</report_available>
<reporting_term>String</reporting_term>
<skip_exact_balance>0</skip_exact_balance>
<skipped>0</skipped>
<state>String</state>
<succeeded>0</succeeded>
<total>0</total>
<updated_utc>0001-01-01T00:00:00</updated_utc>
</job>
</FinanceAccountLateChargeJobResultResponse>