regis

<back to all web services

FinanceAccountLateChargeJobResultRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/AccountLate/{reporting_term}/Jobs/Result
FinanceAccountLateChargeJobResultRequest Parameters:
NameParameterData TypeRequiredDescription
authorizing_uuidbodystringNo
reporting_termpathstringNo
operation_idbodyGuidNo
FinanceAccountLateChargeJobResultResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
jobformFinanceAccountLateChargeJobResponseNo
accountsformList<FinanceAccountLateChargeResponse>No
FinanceAccountLateChargeJobResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
operation_idformGuidNo
reporting_termformstringNo
calculation_dateformDateTimeNo
preview_onlyformboolNo
skip_exact_balanceformdecimal?No
stateformstringNo
totalformint?No
current_regent_idformint?No
processedformintNo
succeededformintNo
skippedformintNo
failedformintNo
created_utcformDateTimeNo
updated_utcformDateTimeNo
messageformstringNo
report_availableformboolNo
outcomesformList<FinanceAccountLateChargeOutcome>No
FinanceAccountLateChargeOutcome Parameters:
NameParameterData TypeRequiredDescription
regent_idformintNo
statusformstringNo
charge_amountformdecimal?No
charge_statusformstringNo
email_statusformstringNo
messageformstringNo
FinanceAccountLateChargeResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
skip_reasonformstringNo
charge_statusformstringNo
email_statusformstringNo
charge_errorformstringNo
email_errorformstringNo
regent_idformintNo
first_nameformstringNo
last_nameformstringNo
uuidformstringNo
has_late_reg_feeformboolNo
amount_owingformdecimalNo
late_feeformdecimalNo
interestformdecimalNo
active_financial_restrictionsformstringNo
new_financial_restrictionformstringNo
last_registration_dateformDateTime?No

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 /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>