regis

<back to all web services

FinanceAdjustmentSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/{uuid}/Adjustment/{reporting_term}/Submit
FinanceAdjustmentSubmitRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
reporting_termpathstringNo
ratesbodyList<FinanceAdjustmentRateSubmitRequest>No
descriptionbodystringNo
authorizing_uuidbodystringNo
is_financial_aidbodyboolNo
added_datebodyDateTimeNo
FinanceAdjustmentRateSubmitRequest Parameters:
NameParameterData TypeRequiredDescription
rate_idformintNo
descriptionformstringNo
chargeformdecimalNo
creditformdecimalNo
custom_glformstringNo

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/{uuid}/Adjustment/{reporting_term}/Submit HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinanceAdjustmentSubmitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <added_date>0001-01-01T00:00:00</added_date>
  <authorizing_uuid>String</authorizing_uuid>
  <description>String</description>
  <is_financial_aid>false</is_financial_aid>
  <rates>
    <FinanceAdjustmentRateSubmitRequest>
      <charge>0</charge>
      <credit>0</credit>
      <custom_gl>String</custom_gl>
      <description>String</description>
      <rate_id>0</rate_id>
    </FinanceAdjustmentRateSubmitRequest>
  </rates>
  <reporting_term>String</reporting_term>
  <uuid>String</uuid>
</FinanceAdjustmentSubmitRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <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>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>